> ## 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.
# v2 panel
> Preview, not deployed. The v2 gateway is built but not deployed yet; this call works once the owner deploys `silo-api`.
A clean (id, date, metric, value) table across families.
Example: `/v2/panel?id=PETR4,VALE3&metric=close_return`
With no `from`, a dated kind reads the last 36 months to `to`.
panel has one kind, so it takes no kind parameter. id is a comma-separated list of tickers, fund CNPJs, option or termo tickers and futures codes. The gateway's tier ceiling (config.ts: 1 id anonymous, 3 signed in) is refused above it (forbidden_for_tier), and the SQL's own (3 anonymous, 50 signed in) is refused verbatim (over_limit); never trimmed.
Missing months stay absent: no fill, no return across a gap. Metric names are catalog().metrics (coverage?kind=catalog); an unknown name is unknown_parameter.
With no id and a family, panel walks the family (universe mode, monthly); min_nav and min_months narrow it. The gateway serves universe mode to the pro tier only (config.ts): a user the owner lists in api_user_tier (#1064).
`GET /v2/panel?help` describes the main parameters, `?help=all` adds the hidden ones.
## OpenAPI
````yaml /api-docs/v2/openapi.json get /panel
openapi: 3.1.0
info:
title: SILO API v2 (preview, not deployed)
version: v2
description: >-
The v2 gateway over SILO's schema `api`: 14 resources, five shared
parameters, one envelope and one error object. Generated from
supabase/functions/silo-api/registry.ts by scripts/gen_openapi_v2.py; do not
edit by hand. Preview, not deployed. The v2 gateway is built but not
deployed yet; this call works once the owner deploys `silo-api`.
servers:
- url: https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2
description: The silo-api Edge Function (preview, not deployed).
security:
- apikey: []
- apikey: []
bearerAuth: []
paths:
/panel:
get:
summary: v2 panel
description: >-
Preview, not deployed. The v2 gateway is built but not deployed
yet; this call works once the owner deploys `silo-api`.
A clean (id, date, metric, value) table across families.
Example: `/v2/panel?id=PETR4,VALE3&metric=close_return`
With no `from`, a dated kind reads the last 36 months to `to`.
panel has one kind, so it takes no kind parameter. id is a
comma-separated list of tickers, fund CNPJs, option or termo tickers and
futures codes. The gateway's tier ceiling (config.ts: 1 id anonymous, 3
signed in) is refused above it (forbidden_for_tier), and the SQL's own
(3 anonymous, 50 signed in) is refused verbatim (over_limit); never
trimmed.
Missing months stay absent: no fill, no return across a gap. Metric
names are catalog().metrics (coverage?kind=catalog); an unknown name is
unknown_parameter.
With no id and a family, panel walks the family (universe mode,
monthly); min_nav and min_months narrow it. The gateway serves universe
mode to the pro tier only (config.ts): a user the owner lists in
api_user_tier (#1064).
`GET /v2/panel?help` describes the main parameters, `?help=all` adds the
hidden ones.
operationId: v2_panel
parameters:
- name: metric
in: query
required: false
description: >-
Comma-separated catalog metric names (close, close_adj,
close_return, volume, nav, delinquency, ...). auto: each id's family
default, as api.panel with no p_metrics (close_adj for shares and
units, close for other tickers, settlement_rate for futures, nav for
funds). Comma-separated list. Default: auto.
schema:
type: string
default: auto
example: close_return
- name: freq
in: query
required: false
description: >-
month: the last session of each month for tickers, the filed month
for funds. day: tickers and futures only (funds file monthly).
Default: month.
schema:
type: string
enum:
- month
- day
default: month
- name: family
in: query
required: false
description: >-
auto: every family a CNPJ files under (a CNPJ filing as fi and fidc
yields one row per family). One family narrows the fund rows to it;
with no id it walks that family (universe mode). Default: auto.
schema:
type: string
enum:
- auto
- fi
- fidc
- fii
- fip
- fiagro
default: auto
- name: id
in: query
required: false
description: >-
The id is a comma-separated list of tickers, fund CNPJs, option or
termo tickers and futures codes, up to the tier's id ceiling.
Default: none.
schema:
type: string
example: PETR4,VALE3
- name: from
in: query
required: false
description: >-
First date of the window, YYYY-MM-DD. Default: the resource's
default window, counted back from to.
schema:
type: string
format: date
- name: to
in: query
required: false
description: >-
Last date of the window, YYYY-MM-DD. Default: the latest complete
period, from coverage.
schema:
type: string
format: date
- name: limit
in: query
required: false
description: >-
The page size. More rows than one page come through next_page_url,
never cut silently; a call stops at the tier's rows-per-call cap
with meta.tier_cap_reached. Default: the tier's page maximum (10
anonymous, 100 signed in); a larger value is coerced to it.
schema:
type: integer
minimum: 1
- name: cursor
in: query
required: false
description: >-
The opaque cursor from a previous next_page_url. It carries every
other parameter: send it alone (another parameter with a different
value is bad_request). Default: none: the first page.
schema:
type: string
- name: min_nav
in: query
required: false
description: >-
Hidden parameter (`?help=all` lists it). Universe mode only: keep
funds whose latest NAV in the window is at least this, BRL. Default:
none: no floor.
schema:
type: number
minimum: 0
- name: min_months
in: query
required: false
description: >-
Hidden parameter (`?help=all` lists it). Universe mode only: keep
funds with at least this many observations of the first metric.
Default: none: no floor.
schema:
type: integer
minimum: 0
responses:
'200':
description: The v2 envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/Envelope'
default:
description: >-
The v2 error object. A SILO refusal (over_limit) keeps its message,
hint and details verbatim.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Envelope:
type: object
required:
- data
- meta
properties:
data:
type: array
items: {}
description: Always a list. Rows as the endpoint returned them; null stays null.
meta:
type: object
required:
- resource
- kind
- request
- id_known
properties:
resource:
type: string
kind:
type:
- string
- 'null'
request:
type: object
description: Every parameter the resource takes, with the default applied.
id_known:
type:
- boolean
- 'null'
description: Whether SILO holds the id; null when the call names none.
endpoint:
type: string
description: The api.* endpoint that answered.
additionalProperties: true
next_page_url:
type: string
description: Present only when more rows remain. It carries one opaque cursor.
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- target
- innererror
properties:
code:
type: string
enum:
- bad_request
- unknown_parameter
- unknown_id
- unauthorized
- forbidden_for_tier
- over_limit
- rate_limited
- timeout
- unavailable
- internal
message:
type: string
target:
type:
- string
- 'null'
innererror:
type: object
properties:
sqlstate:
type:
- string
- 'null'
hint:
type:
- string
- 'null'
details:
type:
- string
- 'null'
securitySchemes:
apikey:
type: apiKey
in: header
name: apikey
description: >-
The public publishable key. It identifies the project, not you, and is
the anonymous tier.
x-default: sb_publishable__yfFQsykAglrvc9GS6_PYw_B24ex437
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Optional. A user JWT from Supabase Auth, for the signed-in tier. Never a
secret key.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.