GETEstavel
/stocksListar acoes
Lista acoes cadastradas e permite busca textual ou paginacao de um resultado em cache.
Ver exemplos de códigoParametros
Parametros de query
| Nome | Tipo | Exigencia | Descricao |
|---|---|---|---|
| search | string | Opcional | Texto para filtrar por ticker ou nome. |
| cache_key | string | Opcional | Chave de cache para consultar um resultado paginado. |
| page | integer | Opcional | Pagina do resultado em cache; obrigatoria quando cache_key for informado. |
Resposta
- Sucesso HTTP
- 200
Resposta ilustrativa. Valores e datas fictícios; não representa uma consulta atual.
PETR4
PETROBRAS
R$ 38,44
- Variação
- +1.77%
- DY
- 4.35%
- P/L
- 8.40
A resposta de GET /stocks vira um cartão de ativo: ticker, close, variation, dividend_yield e price_to_earnings.
{
"pagination": {
"cache_key": "stocks_example",
"page": 1,
"has_next_page": false
},
"stocks": [
{
"cd_cvm": "9512",
"ticker": "PETR4",
"name": "PETROBRAS",
"variation": {
"value": "0.67 (+1.77%)",
"signal": "pos"
},
"currency": "BRL",
"image": "",
"dividend_yield": "4.35%",
"price_to_earnings": "8.40",
"ebitda": "1000000",
"price_to_book": "1.20",
"close": "38.44",
"sector": "Petróleo, Gás e Biocombustíveis"
}
]
}Erros
| Status | Descricao |
|---|---|
| 400 | Parametros ou corpo da requisicao invalidos. |
| 404 | Recurso solicitado nao encontrado. |
| 204 | Nenhum dado encontrado para os criterios informados. |
| 401 | Chave de API ausente ou invalida. |
| 403 | Uma assinatura paga ativa e necessaria para acessar a API. |
| 429 | Limite de requisicoes excedido. |
| 500 | Erro interno inesperado. |
| 503 | Servico temporariamente indisponivel. Tente novamente mais tarde. |