> ## Documentation Index > Fetch the complete documentation index at: https://octo-98895abd.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # rate_hit > Counts one API v2 request in the current minute and returns the bucket's hits so far this minute. A signed-in caller's bucket is u: and p_bucket is ignored, so no user can charge another's; an anonymous caller's bucket is p_bucket, which must be ip:
(22023 otherwise). Deletes at most 100 rows older than one hour on each call. The v2 gateway compares the count with the tier's requests per minute and answers 429 above it. Gateway plumbing: not an MCP tool. It writes a counter row and nothing else. ## OpenAPI ````yaml /openapi.json post /rpc/rate_hit openapi: 3.1.0 info: title: SILO Data API version: '82' summary: >- Read-only Brazilian public financial data: CVM filings, BACEN series, B3 quotes and the B3 BDI group. description: > Schema `api` over PostgREST. Views are `GET /`; functions are `POST /rpc/` with a JSON body. **This document is generated** from the live Postgres catalog by `scripts/gen_openapi.py` — `pg_get_function_arguments` for the RPC signatures, `information_schema.columns` for the view columns, and the granted-to-`anon` privilege set for which objects exist at all. It is not hand-maintained, and `tests/test_openapi_spec.py` fails the build when it drifts from the SQL. ### Two different ceilings Reading one for the other is the most expensive mistake on this API. * **The row cap refuses.** Sixty set-returning functions raise SQLSTATE `22023` when the window they were handed would produce more than 1000 rows. Nothing is trimmed, and the error says why and how to fix it (the message, plus PostgREST's `details` and `hint`). Five of them (`panel`, `quote_history`, `fund_nav`, `index_history`, `trade_consolidated_history`) take a `p_after` cursor so you can walk the series; the other fifty-five ask you to narrow the window. `fund_nav` paging additionally REQUIRES `p_entity_type` — its cursor is a bare period, which is unique only within one family, and CNPJs that file under both `fi` and `fidc` in the same month would otherwise be ambiguous. * **The tier ceiling.** `search_funds` refuses (`22023`) when more rows match than its per-tier maximum (since v81). Two other functions (`option_chain`, `option_exercises`) still silently lower `p_limit` to a per-tier maximum. No error is raised there, so the only way to know the result was cut is to know the ceiling. Signing in raises it. Separately from both, PostgREST's server-wide `db-max-rows = 1000` cuts every response, on every endpoint, for every tier. On the GET views `Content-Range` is the signal (`0-999/*`); `Prefer: count=exact` turns the `*` into a total. ### Retention Most of this warehouse is append-only history. The **B3 BDI group** — `short_interest`, `short_interest_by_sector`, `investor_flow`, `lending_trades`, `lending_participants` — is not: B3 keeps roughly 21 business days and publishes no archive. A missed session cannot be bought back. See Market Coverage. license: name: See repository url: https://github.com/PedroDnT/SILO-BZ servers: - url: https://zcjbtpxuhdekpwcxmepn.supabase.co/rest/v1 description: Supabase PostgREST, schema `api` security: - apikey: [] tags: - name: ANBIMA - name: Company events - name: Coverage & catalog - name: Derivatives - name: FIDC - name: FNET documents - name: Financials - name: Funds - name: Gateway - name: Holdings - name: Inflation - name: Lookup - name: Macro - name: Macro expectations - name: Other - name: Panel - name: Portfolio - name: Quotes - name: Rates - name: Research - name: Screens - name: Securities lending - name: Short interest & flows paths: /rpc/rate_hit: post: tags: - Gateway summary: rate_hit description: >- Counts one API v2 request in the current minute and returns the bucket's hits so far this minute. A signed-in caller's bucket is u: and p_bucket is ignored, so no user can charge another's; an anonymous caller's bucket is p_bucket, which must be ip:
(22023 otherwise). Deletes at most 100 rows older than one hour on each call. The v2 gateway compares the count with the tier's requests per minute and answers 429 above it. Gateway plumbing: not an MCP tool. It writes a counter row and nothing else. operationId: rpc_rate_hit requestBody: required: true content: application/json: schema: type: object properties: p_bucket: type: - string - 'null' description: Defaults to `NULL::text`. default: null responses: '200': description: The result. content: application/json: schema: type: - integer - 'null' format: int32 '400': description: >- Bad request. Contract violations raise SQLSTATE `22023` with a message naming the limit or the argument at fault. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: >- No usable `apikey`, or a request for a schema outside `api`. `Accept-Profile: public` and any `cvm_*` / `b3_cotahist` / `cia_*` path answer 401 for every caller, by grant — schema `api` is the entire public surface. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: No such endpoint in schema `api`. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Error: type: object description: >- PostgREST error body. `code` carries the SQLSTATE — `22023` is a contract refusal. properties: code: type: - string - 'null' examples: - '22023' message: type: - string - 'null' details: type: - string - 'null' hint: type: - string - 'null' securitySchemes: apikey: type: apiKey in: header name: apikey description: >- The publishable key (`sb_publishable_…`), on every request. It is NOT a JWT — sending it as `Authorization: Bearer` is rejected as an invalid JWT. It identifies the project, not you, and maps to the Postgres `anon` role. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.