Gráfico da cotação de criptomoedas por período

Este endpoint possibilita realizar a consulta da cotação de criptomoedas em um determinado período (dia, semana, mês e ano). Os valores retornados são referentes às alterações das cotações no período indicado.

👍
Dica
A partir dos valores retornados, é possível gerar gráficos que demonstram a flutuação do valor da moeda.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O cliente do parceiro possua uma conta ativa.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/v2/crypto/graphs/prices?market={market}&type={type}

--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/v2/crypto/graphs/prices?market=BTC:BRL&type=weekly' \
--header 'accept: application/json' \
--header 'bankly-version: 2023-01-30' \
--header 'authorization: Bearer {Token}'
--header 'bankly-correlation-id: 5a88c4ae-99cd-494e-96b7-39b8109c8a77'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`crypto.graph.read`	Concede acesso para consultar cotações de criptomoedas.

Cabeçalhos (Headers)

Nome	Descrição
`bankly-version`	Obrigatório. Data em que ocorreu a alteração no contrato. Neste caso, insira 2023-01-30.
`authorization`	Obrigatório. Token de autorização do tipo Bearer.
`bankly-correlation-id`	Obrigatório. Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

Parâmetros da rota (Path)

No path desta requisição, envie os seguintes campos:

Nome	Tipo	Descrição
`market`	`query`	Mercado, o qual é constituído da sigla da criptomoeda com a sigla do real. Exemplo: BTC:BRL.
`type`	`query`	Período que deseja exibir, o qual pode ser: “daily” (diário), “weekly” (semanal), “monthly” (mensal) ou “annually” (anual).

As cotações são atualizadas de acordo com o período, sendo:

“daily”: a cada 12 minutos;
“weekly”: a cada 16 minutos;
“monthly”: a cada 24 minutos;
“annually”: a cada 24 horas.

🚧
Importante
O campo type é case sensitive e a primeira letra do valor deve ser minúscula.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.

Sendo bem-sucedido, o retorno irá trazer uma lista de objetos, contendo os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`data`	`number`	Objeto que contém informações sobre o gráfico da cotação de criptomoedas por período.
`data.market`	`string`	O mercado, o qual é constituído da sigla da criptomoeda com a sigla do real. Exemplo: BTC:BRL.
`data.points[]`	`array of objects`	Lista de objetos que contém as variações dos valores da criptomoeda em um determinado período.
`data.points[].price`	`object`	Objeto que contém informações sobre o valor de uma criptomoeda em um momento específico.
`data.points[].price.value`	`number`	Preço final da criptomoeda.
`data.points[].price.currency`	`string`	Código da criptomoeda.
`data.points[].timestamp`	`string`	Data e hora da consulta, no formato ISO 8601 - UTC.
`metadata`	`dictionary<string, object>`	Dicionário de metadados que pode conter informações adicionais da requisição, de acordo com o modelo de negócio do cliente.
`links[]`	`array of objects`	Objeto que poderá conter propriedades adicionais.

{
    "data": {
        "market": "BTC:BRL",
        "points": [
            {
            "price": {
                "value": 106747.5,
                "currency": "BRL"
            },
            "timestamp": "2023-03-09T20:24:00.613Z"
            },
            {
            "price": {
                "value": 106652,
                "currency": "BRL"
            },
            "timestamp": "2023-03-09T20:22:00.413Z"
            }
        ]
    },
    "metadata": {},
    "links": []
}

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar alguns erros específicos, conforme a tabela a seguir:

Status Code	Código	Descrição
422	UNPROCESSABLE_ ENTITY	Requisição não pode ser processada, devido uma regra de negócio.

Além disso, este endpoint também poderá retornar erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.