# Criptomoedas

> Cotações do Bitcoin, Ethereum e das principais criptomoedas do mercado.

Obtenha as cotações das principais **criptomoedas** do mercado em diversas moedas de referência.

## Ativos

Consulte as criptomoedas disponíveis e seus respectivos tickers para utilizar na consulta abaixo.

<stock-search kind="crypto">



</stock-search>

## Requisição

Para consultar um ou mais ativos, informe os tickers no formato `{fonte}:{símbolo}` separados por vírgula. Por exemplo, para consultar **Bitcoin e Ethereum em Real**:

<endpoint endpoint="/v2/finance/quotes?tickers=CRYPTO:BTCBRL,CRYPTO:ETHBRL">



</endpoint>

<request-example endpoint="/v2/finance/quotes?tickers=CRYPTO:BTCBRL,CRYPTO:ETHBRL">



</request-example>

### Parâmetros

<field-group>
<field name="tickers" type="string" :required="true">

Lista de ativos no formato `{fonte}:{símbolo}` separados por vírgula. Ex.: `CRYPTO:BTCBRL,CRYPTO:ETHBRL`.

</field>

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

Ordena os resultados com base em um campo de retorno. Aceita: `value:asc`, `value:desc`, `volume:asc`, `volume:desc`, `change_percent:asc`, `change_percent:desc`.

</field>

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

Filtro de campos para reduzir o payload de retorno. Ex.: `ticker,quote.value,quote.change_percent`. *Em breve.*

</field>
</field-group>

## Resposta

Nos `results`, a API retorna os dados da seguinte forma:

<response-json endpoint="/v2/finance/quotes?tickers=CRYPTO:BTCBRL">



</response-json>

### Campos

Os dados do ativo retornam dentro da lista `results` com os seguintes campos:

#### Ativo

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

<tbody>
  <tr>
    <td>
      <code>
        ticker
      </code>
    </td>
    
    <td>
      Identificador completo no formato <code>
        {source}:{symbol}
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        kind
      </code>
    </td>
    
    <td>
      Tipo do ativo: <code>
        stock
      </code>
      
      , <code>
        bdr
      </code>
      
      , <code>
        etf
      </code>
      
      , <code>
        fund
      </code>
      
      , <code>
        index
      </code>
      
      , <code>
        crypto
      </code>
      
      , <code>
        forex
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        unit
      </code>
    </td>
    
    <td>
      Unidade dos valores (<code>
        currency
      </code>
      
      , <code>
        points
      </code>
      
       etc.)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        currency
      </code>
    </td>
    
    <td>
      Moeda principal
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        symbol
      </code>
    </td>
    
    <td>
      Código de negociação
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        name
      </code>
    </td>
    
    <td>
      Nome simplificado
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        full_name
      </code>
    </td>
    
    <td>
      Nome completo ou razão social
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        tax_id
      </code>
    </td>
    
    <td>
      Documento fiscal do emissor (ex.: CNPJ)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        isin
      </code>
    </td>
    
    <td>
      Código ISIN do ativo
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        shares_outstanding
      </code>
    </td>
    
    <td>
      Quantidade de ações em circulação
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        classification.sector
      </code>
    </td>
    
    <td>
      Setor de atuação
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        classification.subsector
      </code>
    </td>
    
    <td>
      Subsetor de atuação
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        classification.segment
      </code>
    </td>
    
    <td>
      Segmento de atuação
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        logos.square_small
      </code>
    </td>
    
    <td>
      URL do logotipo quadrado em tamanho pequeno
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        logos.square_large
      </code>
    </td>
    
    <td>
      URL do logotipo quadrado em tamanho grande
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        related
      </code>
    </td>
    
    <td>
      Lista de tickers relacionados no formato <code>
        {source}:{symbol}
      </code>
    </td>
  </tr>
</tbody>
</table>

#### Quote

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

<tbody>
  <tr>
    <td>
      <code>
        quote.value
      </code>
    </td>
    
    <td>
      Último valor negociado (moeda, pontos etc.)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        quote.change_value
      </code>
    </td>
    
    <td>
      Variação absoluta no dia
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        quote.change_percent
      </code>
    </td>
    
    <td>
      Variação percentual no dia
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        quote.market_cap
      </code>
    </td>
    
    <td>
      Valor de mercado com base na cotação atual
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        quote.updated_at
      </code>
    </td>
    
    <td>
      Timestamp da cotação (ISO 8601)
    </td>
  </tr>
</tbody>
</table>

#### Market

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

<tbody>
  <tr>
    <td>
      <code>
        market.is_open
      </code>
    </td>
    
    <td>
      Indica se o mercado está aberto
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        market.open_time
      </code>
    </td>
    
    <td>
      Horário de abertura do mercado (ISO 8601)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        market.close_time
      </code>
    </td>
    
    <td>
      Horário de fechamento do mercado (ISO 8601)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        market.previous_value
      </code>
    </td>
    
    <td>
      Valor de referência anterior (ex.: fechamento anterior)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        market.open
      </code>
    </td>
    
    <td>
      Valor de abertura do dia
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        market.high
      </code>
    </td>
    
    <td>
      Máxima do dia
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        market.low
      </code>
    </td>
    
    <td>
      Mínima do dia
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        market.close
      </code>
    </td>
    
    <td>
      Valor de fechamento do dia
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        market.volume
      </code>
    </td>
    
    <td>
      Volume negociado
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        market.updated_at
      </code>
    </td>
    
    <td>
      Timestamp da sessão (ISO 8601)
    </td>
  </tr>
</tbody>
</table>

#### Dividends

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

<tbody>
  <tr>
    <td>
      <code>
        dividends.yield_12m_percent
      </code>
    </td>
    
    <td>
      Dividend yield dos últimos 12 meses em percentual
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        dividends.yield_12m_cash
      </code>
    </td>
    
    <td>
      Dividend yield dos últimos 12 meses em valor absoluto (moeda)
    </td>
  </tr>
</tbody>
</table>

#### Fonte

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

<tbody>
  <tr>
    <td>
      <code>
        source.symbol
      </code>
    </td>
    
    <td>
      Código da fonte
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        source.name
      </code>
    </td>
    
    <td>
      Nome da fonte
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        source.full_name
      </code>
    </td>
    
    <td>
      Nome completo da fonte
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        source.url
      </code>
    </td>
    
    <td>
      Site oficial
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        source.location.timezone
      </code>
    </td>
    
    <td>
      Fuso horário
    </td>
  </tr>
</tbody>
</table>