# Lista de Ativos

> 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`.

<callout color="info" icon="tabler:info-circle">

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

</callout>

## Requisição

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

<endpoint endpoint="/v2/finance/tickers?query=petr&sources=B3&sort=symbol&order=asc">



</endpoint>

<request-example endpoint="/v2/finance/tickers?query=petr&sources=B3&sort=symbol&order=asc">



</request-example>

### Parâmetros

<field-group>
<field name="query" type="string">

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

</field>

<field name="sources" type="string">

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

</field>

<field name="page" type="integer">

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

</field>

<field name="sort" type="string">

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

</field>

<field name="order" type="string">

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

</field>
</field-group>

### Fontes

<table>
<thead>
  <tr>
    <th>
      Fonte
    </th>
    
    <th>
      Descrição
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        B3
      </code>
    </td>
    
    <td>
      Ativos negociados na B3.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        FOREX
      </code>
    </td>
    
    <td>
      Pares de moedas internacionais.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        BINANCE
      </code>
    </td>
    
    <td>
      Criptomoedas disponíveis na Binance.
    </td>
  </tr>
</tbody>
</table>

## Exemplos

### Buscar por nome

<endpoint endpoint="/v2/finance/tickers?query=petrobras">



</endpoint>

### Filtrar por fonte

<endpoint endpoint="/v2/finance/tickers?sources=FOREX">



</endpoint>

### Combinar fontes

<endpoint endpoint="/v2/finance/tickers?sources=B3,FOREX&sort=name">



</endpoint>

## Resposta

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

<response-json endpoint="/v2/finance/tickers?query=petr&sources=B3&sort=symbol&order=asc">



</response-json>

### Campos

#### Metadados

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

<table>
<thead>
  <tr>
    <th>
      Campo
    </th>
    
    <th>
      Tipo
    </th>
    
    <th>
      Descrição
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        key_status
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Situação da chave de integração.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        cached
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          boolean
        </span>
      </code>
    </td>
    
    <td>
      Indica se a resposta veio do cache.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        response_time_ms
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          number
        </span>
      </code>
    </td>
    
    <td>
      Tempo de resposta em milissegundos.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        language
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Idioma usado nos textos da resposta.
    </td>
  </tr>
</tbody>
</table>

#### Ativo

Cada item de `results` representa um ativo disponível:

<table>
<thead>
  <tr>
    <th>
      Campo
    </th>
    
    <th>
      Tipo
    </th>
    
    <th>
      Descrição
    </th>
    
    <th>
      Exemplo
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        ticker
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Identificador no formato <code>
        {fonte}:{símbolo}
      </code>
      
      .
    </td>
    
    <td>
      B3:PETR4
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        kind
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Tipo do ativo.
    </td>
    
    <td>
      stock
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        symbol
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Código de negociação do ativo.
    </td>
    
    <td>
      PETR4
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        name
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Nome simplificado.
    </td>
    
    <td>
      Petrobras
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        full_name
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Nome completo ou razão social.
    </td>
    
    <td>
      Petróleo Brasileiro S.A. Petrobras
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        tax_id
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Documento fiscal do emissor, como CNPJ.
    </td>
    
    <td>
      33.000.167/0001-01
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        isin
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Código ISIN do ativo.
    </td>
    
    <td>
      BRPETRACNPR6
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        classification.sector
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Setor de atuação.
    </td>
    
    <td>
      Petróleo, Gás e Biocombustíveis
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        classification.subsector
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Subsetor de atuação.
    </td>
    
    <td>
      Petróleo, Gás e Biocombustíveis
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        classification.segment
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Segmento de atuação.
    </td>
    
    <td>
      Exploração, Refino e Distribuição
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        logos.square_small
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      URL do logotipo quadrado pequeno.
    </td>
    
    <td>
      https://...
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        logos.square_large
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      URL do logotipo quadrado grande.
    </td>
    
    <td>
      https://...
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        source.symbol
      </code>
    </td>
    
    <td>
      <code className="language-ts-type shiki shiki-themes one-light one-dark-pro one-dark-pro" language="ts-type" style="">
        <span class="s3iYH">
          string
        </span>
      </code>
    </td>
    
    <td>
      Código da fonte do ativo.
    </td>
    
    <td>
      B3
    </td>
  </tr>
</tbody>
</table>

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](/docs/finance/stocks), [histórico](/docs/finance/history), [dividendos](/docs/finance/dividends) ou nos endpoints de demonstrativos.
