Ir para o conteúdo principal
QuantanSite

Referência da API

Documentação da API

Uma API JSON somente leitura sobre os mesmos dados de mercado que este site exibe. As respostas bem-sucedidas usam o envelope { data, meta }; as falhas usam { error: { code, message } }.

URL base
http://localhost:3000
Métodos
Somente GET
Formato
JSON, UTF-8
Limite de requisições
60 requisições a cada 60 segundos, por endereço IP e endpoint

These are API examples. This site is served as static files.

Demo
As respostas vêm de um conjunto de dados de demonstração determinístico com emissores fictícios, a menos que o servidor defina MARKET_DATA_PROVIDER=fmp junto com FMP_API_KEY. O campo meta.provider de cada resposta indica qual fonte respondeu.

Listar cotações

GET/api/quotes

Retorna uma página de instrumentos como um array simples, com total, page e pageSize em meta. Todos os filtros do screener abaixo também funcionam aqui; valores que não podem ser interpretados são ignorados.

Parâmetros

ParâmetroEmTipoObrigatórioDescrição
sectorquerystringOpcionalNome exato do setor: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
sortquerystringOpcionalCampo de ordenação: marketCap (padrão), price, changePercent, volume ou symbol.
orderquerystringOpcionalOrdem de classificação: desc (padrão) ou asc.
pagequerynumberOpcionalNúmero da página, começando em 1.
pageSizequerynumberOpcionalLinhas por página: 20 por padrão, 100 no máximo.

Requisição

curl -s "http://localhost:3000/api/quotes?pageSize=3"

Exemplo de resposta

200application/json

{
  "data": [
    {
      "symbol": "NWRB",
      "name": "Northwind Robotics",
      "exchange": "NASDAQ",
      "sector": "Technology",
      "industry": "Industrial Automation",
      "price": 733.8,
      "change": -16.52,
      "changePercent": -2.2,
      "previousClose": 750.32,
      "open": 750.03,
      "dayHigh": 751.29,
      "dayLow": 731.5,
      "volume": 3471317,
      "avgVolume": 2962633,
      "marketCap": 982258754565,
      "peRatio": 60.35,
      "eps": 12.16,
      "dividendYield": null,
      "week52High": 963.99,
      "week52Low": 583.89,
      "afterHoursPrice": 731,
      "afterHoursChangePercent": -0.38,
      "updatedAt": "2026-11-12T21:00:00.000Z"
    }
  ],
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
    "total": 20,
    "page": 1,
    "pageSize": 3
  }
}

O exemplo foi reduzido a uma linha.

Obter uma cotação

GET/api/quotes/{symbol}

Retorna a cotação completa de um instrumento ou índice. Um símbolo desconhecido retorna 404 not_found.

Parâmetros

ParâmetroEmTipoObrigatórioDescrição
symbolpathstringObrigatórioSímbolo do instrumento ou índice, por exemplo NWRB. A correspondência ignora maiúsculas e minúsculas.

Requisição

curl -s "http://localhost:3000/api/quotes/NWRB"

Exemplo de resposta

200application/json

{
  "data": {
    "symbol": "NWRB",
    "name": "Northwind Robotics",
    "exchange": "NASDAQ",
    "sector": "Technology",
    "industry": "Industrial Automation",
    "price": 733.8,
    "change": -16.52,
    "changePercent": -2.2,
    "previousClose": 750.32,
    "open": 750.03,
    "dayHigh": 751.29,
    "dayLow": 731.5,
    "volume": 3471317,
    "avgVolume": 2962633,
    "marketCap": 982258754565,
    "peRatio": 60.35,
    "eps": 12.16,
    "dividendYield": null,
    "week52High": 963.99,
    "week52Low": 583.89,
    "afterHoursPrice": 731,
    "afterHoursChangePercent": -0.38,
    "updatedAt": "2026-11-12T21:00:00.000Z"
  },
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice."
  }
}

Obter velas

GET/api/candles/{symbol}

Retorna velas OHLCV, da mais antiga para a mais recente. O intervalo 1D usa velas de 30-minute; qualquer outro intervalo usa velas diárias. Um intervalo desconhecido retorna 400 bad_request.

Parâmetros

ParâmetroEmTipoObrigatórioDescrição
symbolpathstringObrigatórioSímbolo do instrumento ou índice, por exemplo NWRB. A correspondência ignora maiúsculas e minúsculas.
rangequerystringOpcionalUm de 1D, 5D, 1M, 6M, 1Y, 5Y. O padrão é 1M.

Requisição

curl -s "http://localhost:3000/api/candles/NWRB?range=1M"

Exemplo de resposta

200application/json

{
  "data": [
    {
      "time": "2026-11-11",
      "open": 757.4,
      "high": 761.18,
      "low": 743.92,
      "close": 750.32,
      "volume": 3531710
    },
    {
      "time": "2026-11-12",
      "open": 750.03,
      "high": 751.29,
      "low": 731.5,
      "close": 733.8,
      "volume": 3471317
    }
  ],
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
    "symbol": "NWRB",
    "range": "1M"
  }
}

O exemplo foi reduzido a duas velas; 1M retorna 22.

Triar instrumentos

GET/api/screener

Filtra, ordena e pagina instrumentos com os mesmos parâmetros da página do screener. O resultado traz rows junto com total, page e pageSize; valores que não podem ser interpretados são ignorados.

Parâmetros

ParâmetroEmTipoObrigatórioDescrição
sectorquerystringOpcionalNome exato do setor: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
minMarketCap, maxMarketCapquerynumberOpcionalLimites de valor de mercado em USD.
minPrice, maxPricequerynumberOpcionalLimites de preço em USD.
minChangePercent, maxChangePercentquerynumberOpcionalLimites de variação diária em pontos percentuais: -3 significa -3%.
minVolumequerynumberOpcionalVolume diário mínimo em ações.
profitableOnlyquerystringOpcionalDefina como 1 para manter apenas instrumentos com EPS acima de 0.
sortquerystringOpcionalCampo de ordenação: marketCap (padrão), price, changePercent, volume ou symbol.
orderquerystringOpcionalOrdem de classificação: desc (padrão) ou asc.
pagequerynumberOpcionalNúmero da página, começando em 1.
pageSizequerynumberOpcionalLinhas por página: 20 por padrão, 100 no máximo.

Requisição

curl -s "http://localhost:3000/api/screener?profitableOnly=1&pageSize=5"

Exemplo de resposta

200application/json

{
  "data": {
    "rows": [
      {
        "symbol": "NWRB",
        "name": "Northwind Robotics",
        "exchange": "NASDAQ",
        "sector": "Technology",
        "industry": "Industrial Automation",
        "price": 733.8,
        "change": -16.52,
        "changePercent": -2.2,
        "previousClose": 750.32,
        "open": 750.03,
        "dayHigh": 751.29,
        "dayLow": 731.5,
        "volume": 3471317,
        "avgVolume": 2962633,
        "marketCap": 982258754565,
        "peRatio": 60.35,
        "eps": 12.16,
        "dividendYield": null,
        "week52High": 963.99,
        "week52Low": 583.89,
        "afterHoursPrice": 731,
        "afterHoursChangePercent": -0.38,
        "updatedAt": "2026-11-12T21:00:00.000Z"
      }
    ],
    "total": 17,
    "page": 1,
    "pageSize": 5
  },
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
    "total": 17,
    "page": 1,
    "pageSize": 5
  }
}

O exemplo foi reduzido a uma linha.

Autenticação

O modo de demonstração não precisa de chave. Quando o servidor define a variável de ambiente API_KEY, toda requisição deve enviar o mesmo valor no cabeçalho X-API-Key; qualquer outro valor recebe 401 unauthorized.

curl -s "http://localhost:3000/api/quotes/NWRB" \
  -H "X-API-Key: your-key-here"
Observação
A chave é lida apenas no servidor. Os botões Enviar requisição desta página chamam a API pelo navegador sem chave, portanto retornam 401 enquanto a autenticação por chave estiver ativa.

Códigos de erro

Requisições que falham retornam um status HTTP correspondente e um único objeto de erro. Ramifique por code; a message é escrita para pessoas e pode mudar.

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation."
  }
}
Status HTTPCódigoQuando acontece
400bad_requestUm valor de parâmetro não é permitido, por exemplo um intervalo de velas desconhecido.
401unauthorizedAPI_KEY está configurada e a requisição não tem um cabeçalho X-API-Key correspondente.
404not_foundO símbolo não existe no conjunto de dados.
405method_not_allowedA API é somente leitura: /api/quotes responde a POST com este código.
429rate_limitedMais de 60 requisições em 60 segundos de um endereço IP para um endpoint. A resposta inclui Retry-After em segundos.

Veja os mesmos dados no produto

A visão geral do mercado, as páginas de cotação e o screener leem o mesmo provedor que esses endpoints.