Skip to content

Repository navigation

docs(fmp-py): clarify base_url and path_prefix URL resolution #425

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
benbenbang merged 1 commit into from
Oct 12, 2026
Merged

docs(fmp-py): clarify base_url and path_prefix URL resolution #425

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions crates/fmp-py/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,19 @@ The rules:
`FMP_BASE_URL` only replaces the base URL; the `token` and `FMP_API_KEY`
rules above are unchanged.

The base URL is only the origin, plus any proxy path. The `stable` version
segment comes from `path_prefix` (default `"stable"`), which is always added
after it:

| `base_url` | `path_prefix` | `quote` resolves to |
| --- | --- | --- |
| omitted, or `https://financialmodelingprep.com` | default | `https://financialmodelingprep.com/stable/quote` |
| `https://financialmodelingprep.com/stable` | default | `.../stable/stable/quote`: **404** |
| `https://financialmodelingprep.com/stable` | `""` | `https://financialmodelingprep.com/stable/quote` |

To set the default explicitly, pass `base_url="https://financialmodelingprep.com"`
without `/stable`.

To read the proxy's cache status and remaining daily budget on a success,
pass `on_response`. It is called as `on_response(endpoint_id, status,
headers)` after every successful call, from any namespace:
Expand Down
Loading