Lista de Ativos

Finance

Consulte os tickers disponíveis no módulo Finance.

Use a lista de ativos para descobrir quais tickers estão disponíveis antes de consultar cotações, histórico, dividendos, fundamentos ou demonstrativos financeiros.

Cada item retorna o identificador no formato {fonte}:{símbolo}, como B3:PETR4, FOREX:USDBRL ou BINANCE:BTCBRL.

Use sempre o campo ticker retornado por este endpoint nos outros endpoints do Finance.

Requisição

Busque ativos por símbolo, nome simplificado ou razão social.

GEThttps://api.hgbrasil.com/v2/finance/tickers?query=petr&sources=B3&sort=symbol&order=asc&key=suachave

curl -X GET "https://api.hgbrasil.com/v2/finance/tickers?query=petr&sources=B3&sort=symbol&order=asc&key=suachave"

const url = new URL("/v2/finance/tickers", "https://api.hgbrasil.com")

url.searchParams.set("query", "petr")
url.searchParams.set("sources", "B3")
url.searchParams.set("sort", "symbol")
url.searchParams.set("order", "asc")
url.searchParams.set("key", "suachave")

const response = await fetch(url.href)
const data = await response.json()

$url = 'https://api.hgbrasil.com/v2/finance/tickers';

$queryString = http_build_query([
    'query' => 'petr',
    'sources' => 'B3',
    'sort' => 'symbol',
    'order' => 'asc',
    'key' => 'suachave'
]);

$response = file_get_contents($url . '?' . $queryString);
$data = json_decode($response, true);

import requests

url = 'https://api.hgbrasil.com/v2/finance/tickers'

params = {
    'query': 'petr',
    'sources': 'B3',
    'sort': 'symbol',
    'order': 'asc',
    'key': 'suachave'
}

response = requests.get(url, params=params)
data = response.json()

require 'net/http'
require 'uri'
require 'json'

uri = URI('https://api.hgbrasil.com/v2/finance/tickers')

uri.query = URI.encode_www_form({
  query: 'petr',
  sources: 'B3',
  sort: 'symbol',
  order: 'asc',
  key: 'suachave'
})

response = Net::HTTP.get(uri)
data = JSON.parse(response, symbolize_names: true)

import java.net.URI;
import java.net.http.*;

var url = "https://api.hgbrasil.com/v2/finance/tickers?query=petr&sources=B3&sort=symbol&order=asc&key=suachave";

var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder()
    .uri(URI.create(url))
    .GET()
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
var data = response.body();

using System.Net.Http;
using System.Text.Json;
using System.Web;

var client = new HttpClient();
var baseUrl = "https://api.hgbrasil.com/v2/finance/tickers";

var queryParams = HttpUtility.ParseQueryString(string.Empty);
queryParams["query"] = "petr";
queryParams["sources"] = "B3";
queryParams["sort"] = "symbol";
queryParams["order"] = "asc";
queryParams["key"] = "suachave";

var url = $"{baseUrl}?{queryParams}";
var response = await client.GetStringAsync(url);
var data = JsonSerializer.Deserialize<dynamic>(response);

Parâmetros

query

string

Busca textual por símbolo, nome simplificado ou razão social. Ex.: petr, petrobras.

sources

string

Lista de fontes separadas por vírgula. Ex.: B3, FOREX, BINANCE ou B3,FOREX.

page

integer

Página da lista. Começa em 1 (padrão). A quantidade de itens por página depende do limite do seu plano.

sort

string

Campo usado na ordenação principal. Padrão: symbol. Aceita: symbol, name.

order

string

Direção da ordenação. Padrão: asc. Aceita: asc, desc.

Fontes

Fonte	Descrição
`B3`	Ativos negociados na B3.
`FOREX`	Pares de moedas internacionais.
`BINANCE`	Criptomoedas disponíveis na Binance.

Exemplos

Buscar por nome

GEThttps://api.hgbrasil.com/v2/finance/tickers?query=petrobras&key=suachave

Filtrar por fonte

GEThttps://api.hgbrasil.com/v2/finance/tickers?sources=FOREX&key=suachave

Combinar fontes

GEThttps://api.hgbrasil.com/v2/finance/tickers?sources=B3,FOREX&sort=name&key=suachave

Resposta

Nos results, a API retorna a lista de ativos encontrados.

{
  "metadata": {
    "key_status": "valid",
    "cached": false,
    "response_time_ms": 24.581,
    "language": "pt-br"
  },
  "results": [
    {
      "ticker": "B3:BRAV3",
      "kind": "stock",
      "symbol": "BRAV3",
      "name": "Brava",
      "full_name": "3R Petroleum Óleo e Gás S.A",
      "tax_id": "12.091.809/0001-55",
      "classification": {
        "sector": "Petróleo, Gás e Biocombustíveis"
      },
      "logos": null,
      "source": {
        "symbol": "B3"
      }
    },
    {
      "ticker": "B3:E1CO34",
      "kind": "bdr",
      "symbol": "E1CO34",
      "name": "Ecopetrol Sa",
      "full_name": "Ecopetrol S.A.",
      "tax_id": null,
      "classification": {
        "sector": "Energia"
      },
      "logos": {
        "square_small": "https://assets.hgbrasil.com/finance/companies/small/ecopetrol-sa.png",
        "square_large": "https://assets.hgbrasil.com/finance/companies/big/ecopetrol-sa.png"
      },
      "source": {
        "symbol": "B3"
      }
    },
    {
      "ticker": "B3:M1PC34",
      "kind": "bdr",
      "symbol": "M1PC34",
      "name": "Marathon Petroleum Corporation",
      "full_name": "Marathon Petroleum Corporation",
      "tax_id": null,
      "classification": {
        "sector": "Petróleo, Gás e Biocombustíveis"
      },
      "logos": null,
      "source": {
        "symbol": "B3"
      }
    },
    {
      "ticker": "B3:OXYP34",
      "kind": "bdr",
      "symbol": "OXYP34",
      "name": "Occidental Petroleum Corporation",
      "full_name": "Occidental Petroleum Corporation",
      "tax_id": null,
      "classification": {
        "sector": "Energia"
      },
      "logos": null,
      "source": {
        "symbol": "B3"
      }
    },
    {
      "ticker": "B3:PETR3",
      "kind": "stock",
      "symbol": "PETR3",
      "name": "Petrobrás",
      "full_name": "Petroleo Brasileiro S.A. Petrobras",
      "tax_id": "33.000.167/0001-01",
      "classification": {
        "sector": "Petróleo, Gás e Biocombustíveis"
      },
      "logos": {
        "square_small": "https://assets.hgbrasil.com/finance/companies/small/petrobras.png",
        "square_large": "https://assets.hgbrasil.com/finance/companies/big/petrobras.png"
      },
      "source": {
        "symbol": "B3"
      }
    },
    {
      "ticker": "B3:PETR4",
      "kind": "stock",
      "symbol": "PETR4",
      "name": "Petrobrás",
      "full_name": "Petroleo Brasileiro S.A. Petrobras",
      "tax_id": "33.000.167/0001-01",
      "classification": {
        "sector": "Petróleo, Gás e Biocombustíveis"
      },
      "logos": {
        "square_small": "https://assets.hgbrasil.com/finance/companies/small/petrobras.png",
        "square_large": "https://assets.hgbrasil.com/finance/companies/big/petrobras.png"
      },
      "source": {
        "symbol": "B3"
      }
    },
    {
      "ticker": "B3:PRIO3",
      "kind": "stock",
      "symbol": "PRIO3",
      "name": "Petrorio",
      "full_name": "Petro Rio S.A.",
      "tax_id": "10.629.105/0001-68",
      "classification": {
        "sector": "Petróleo, Gás e Biocombustíveis"
      },
      "logos": {
        "square_small": "https://assets.hgbrasil.com/finance/companies/small/petrorio.png",
        "square_large": "https://assets.hgbrasil.com/finance/companies/big/petrorio.png"
      },
      "source": {
        "symbol": "B3"
      }
    },
    {
      "ticker": "B3:RECV3",
      "kind": "stock",
      "symbol": "RECV3",
      "name": "Petrorecôncavo S.A.",
      "full_name": "Petrorecôncavo S.A.",
      "tax_id": "03.342.704/0001-30",
      "classification": {
        "sector": "Petróleo, Gás e Biocombustíveis"
      },
      "logos": {
        "square_small": "https://assets.hgbrasil.com/finance/companies/small/petroreconcavo-s-a.png",
        "square_large": "https://assets.hgbrasil.com/finance/companies/big/petroreconcavo-s-a.png"
      },
      "source": {
        "symbol": "B3"
      }
    },
    {
      "ticker": "B3:RPMG3",
      "kind": "stock",
      "symbol": "RPMG3",
      "name": "Pet Manguinh",
      "full_name": "Refinaria De Petroleos Manguinhos S.A.",
      "tax_id": "33.412.081/0001-96",
      "classification": {
        "sector": "Petróleo, Gás e Biocombustíveis"
      },
      "logos": null,
      "source": {
        "symbol": "B3"
      }
    }
  ]
}

Campos

Metadados

O objeto metadata informa o estado da requisição:

Campo	Tipo	Descrição
`key_status`	`string`	Situação da chave de integração.
`cached`	`boolean`	Indica se a resposta veio do cache.
`response_time_ms`	`number`	Tempo de resposta em milissegundos.
`language`	`string`	Idioma usado nos textos da resposta.

Ativo

Cada item de results representa um ativo disponível:

Campo	Tipo	Descrição	Exemplo
`ticker`	`string`	Identificador no formato `{fonte}:{símbolo}`.	B3:PETR4
`kind`	`string`	Tipo do ativo.	stock
`symbol`	`string`	Código de negociação do ativo.	PETR4
`name`	`string`	Nome simplificado.	Petrobras
`full_name`	`string`	Nome completo ou razão social.	Petróleo Brasileiro S.A. Petrobras
`tax_id`	`string`	Documento fiscal do emissor, como CNPJ.	33.000.167/0001-01
`isin`	`string`	Código ISIN do ativo.	BRPETRACNPR6
`classification.sector`	`string`	Setor de atuação.	Petróleo, Gás e Biocombustíveis
`classification.subsector`	`string`	Subsetor de atuação.	Petróleo, Gás e Biocombustíveis
`classification.segment`	`string`	Segmento de atuação.	Exploração, Refino e Distribuição
`logos.square_small`	`string`	URL do logotipo quadrado pequeno.	https://...
`logos.square_large`	`string`	URL do logotipo quadrado grande.	https://...
`source.symbol`	`string`	Código da fonte do ativo.	B3

Valores que não se aplicam a um tipo de ativo podem retornar como null.

Tipos de ativo

O campo kind pode retornar:

stock: ação;
bdr: BDR;
etf: ETF;
fund: fundo;
index: índice;
crypto: criptomoeda;
forex: par de moedas.

Próximo passo

Depois de encontrar o ticker desejado, use o valor de ticker em cotações, histórico, dividendos ou nos endpoints de demonstrativos.

Modo Kiosque

Dashboard financeiro para exibição em TVs, painéis e monitores.

Moedas

Cotações de moedas internacionais em relação ao Real (BRL) e outros pares globais.