Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Dados B3 Planilha API
description: 'Dados fundamentalistas de companhias abertas brasileiras com metodologia 100% pública e invariantes de dado publicados. Fontes: CVM (dados abertos, ODbL) e B3 (COTAHIST fim-de-dia). Todo número carrega a conta CVM de origem; valor duvidoso carrega flag, nunca estimativa escondida.'
version: 0.1.0
tags:
- name: Planilha
paths:
/planilha/dados:
get:
summary: Planilha Dados
description: 'A rota da função =DADOSB3() do Google Planilhas: `codigos` (até 300, separados por vírgula; vazio mantém o
lugar), `campo` (um ou vários, separados por vírgula: roe, pl, dy_12m... ou `valor` para SELIC, IPCA, DOLAR) e
`data` (AAAA-MM-DD, opcional: o valor como era conhecido naquele dia). EXIGE CHAVE (X-API-Key; a grátis serve).
Gasta 1 consulta da cota a cada 100 células (código × campo), mínimo 1. Cada valor ausente vem com o motivo.
Não há campo de preço: na planilha o preço vem do Google (=GOOGLEFINANCE). Lista de campos: /planilha#campos.'
operationId: planilha_dados_planilha_dados_get
parameters:
- name: codigos
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Codigos
- name: campo
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Campo
- name: data
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Data
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Planilha
/planilha:
get:
summary: Planilha Pagina
description: 'A página da Planilha Dados B3: o que é, os três passos, os campos, os limites e de onde vem o preço. ABERTA.'
operationId: planilha_pagina_planilha_get
parameters:
- name: lang
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Lang
- name: accept-language
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Accept-Language
responses:
'200':
description: Successful Response
content:
text/html:
schema:
type: string
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Planilha
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
ChaveApiNaUrl:
type: apiKey
in: query
name: chave
description: Alternativa ao cabeçalho para clientes que só abrem URL (navegação de IA). Fica no histórico e nos logs de quem a usa.
ChaveApi:
type: apiKey
in: header
name: X-API-Key
description: 'Chave grátis (200 consultas/dia) ou Pro em /assinar. Abertos sem chave (limite por IP): fatos, indicadores, múltiplos e dividendos de qualquer ticker, ficha e ranking de FII. WEGE3, MXRF11, /hoje, /saude e a metodologia são abertos. Exigem chave: as_of, versões, preços, screener, /dump.'