Sobre

A Bitnuvem oferece duas APIs para integrar nossas funcionalidades em suas aplicações.

API de Dados

A API de Dados da Bitnuvem é uma API pública que proporciona acesso em tempo real a informações detalhadas sobre cada ativo disponível em nossa corretora. Com esta API, os desenvolvedores podem integrar dados como o livro de ofertas, cotações e taxas aplicadas pela rede diretamente em suas aplicações.

API de Negociação

A API de Negociação da Bitnuvem é projetada para realizar operações em sua conta, permitindo que consulte seu portfólio, gerencie suas ordens, efetue saques e realize envios de criptoativos, entre outras funcionalidades. Ela é feita para integrar e automatizar processos de negociação e gestão de ativos em suas aplicações.

Limite que requisições

As APIs de Dados e de Negociação da Bitnuvem têm um limite de 60 requisições por minuto. Se esse limite for ultrapassado, o sistema retornará uma mensagem padrão indicando que o limite de requisições foi excedido.

Criptoativos

Lista de ativos

Pares negociados

Lista de pares

Padrões de Retorno

Estrutura dos retornos

Retorno de sucesso

Retorno de erro

Lista de códigos

Introdução

Requisições

Para uso da API de Dados deve usar a URL abaixo, alterando os campos em destaque com os parametros desejados:

Mercado / Negociações

Confira os endpoint para consultar informações dos ativos na corretora.

Ticker do ativo

Método para obter informação de melhor oferta de venda e compra atual, último valor negociado, maior valor negociado nas últimas 24 horas, menor valor negociado nas últimas 24 horas, volume total negociado nas últimas 24 horas.

Parâmetros da URL

Retorno

Livro de ofertas

Método para obter informações das ofertas de compra e venda atuais no livro de oferta. Usamos bids para as ofertas de compra e asks para as ofertas de vendas.

Parâmetros da URL

Retorno

Negociações

Método para obter informações das transações de compra e venda realizadas em um intervalo de datas.

A requisição retorna um array de objetos e tem um limite de 1000 registros.

Parâmetros da URL

Parâmetros

Retorno (objeto da array)

Taxas de envio

Taxas de envio

A consulta retornará as opções de envio disponíveis do criptoativo.

Parâmetros da URL

Retorno

Introdução

Primeiros passos

Para utilizar a este recurso é necessário estar com o cadastro completo e solicitar a criação de uma Chave API na sua conta Bitnuvem.

Quando criar uma nova chave, salve a chave secreta em um local seguro, ela é necessária para realizar as requisições.

Requisições

Para usar a API de Negociações deve enviar a estrutura padrão de dados para a URL abaixo:

Autenticação

Requisições

Para qualquer requisição da API de negociação é necessário encaminhar ao endpoint uma estrutura padrão com as informações da sua chave, parâmetros da requisição e assinatura.

No campo request_body sempre vai precisar encaminhar o timestamp atual em segundos junto com os demais parâmetros, se necessário.

Estrutura padrão

const crypto = require('crypto');
const axios = require('axios');

const action = 'withdraw';
const api_key = 'SUA_API_KEY_AQUI';
const api_secret = 'SEGREDO_DA_API_KEY_AQUI';

const request_body = {
    timestamp: Math.floor(Date.now() / 1000),
    value: 120.20,
    bank_id: 231
    // ... outros parâmetros se necessário
};

const queryString = new URLSearchParams(request_body).toString();
const signature = crypto.createHmac('sha256', api_secret).update(queryString).digest('hex');

const api_post = {
    api_key: api_key,
    request_body: queryString,
    signature: signature
};

axios.post(`https://bitnuvem.com/tapi/v2/${action}`, api_post)
    .then(response => {
        console.log(response.data);
    })
    .catch(error => {
        console.error(error);
    });

import time
import hmac
import hashlib
import requests

action = 'withdraw'
api_key = 'SUA_API_KEY_AQUI'
api_secret = 'SEGREDO_DA_API_KEY_AQUI'

request_body = {
    'timestamp': int(time.time()),
    'value': 120.20,
    'bank_id': 231
    # ... outros parâmetros se necessário
}

query_string = '&'.join([f"{key}={value}" for key, value in request_body.items()])
signature = hmac.new(api_secret.encode(), query_string.encode(), hashlib.sha256).hexdigest()

api_post = {
    'api_key': api_key,
    'request_body': query_string,
    'signature': signature
}

response = requests.post(f'https://bitnuvem.com/tapi/v2/{action}', data=api_post)
print(response.text)

$action = 'withdraw';
$api_key = 'SUA_API_KEY_AQUI';
$api_secret = 'SEGREDO_DA_API_KEY_AQUI';

$request_body['timestamp'] = time();

$request_body['value'] = 120.20;
$request_body['bank_id'] = 231;
// ... outros parâmetros se necessário

// conversão da variável em formato QueryString ( timestamp=123456789&value=120.20&bank_id=231 )
$request_body = http_build_query($request_body);

$api_post['api_key'] = $api_key;
$api_post['request_body'] = $request_body;
$api_post['signature'] = hash_hmac('sha256', $request_body, $api_secret);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://bitnuvem.com/tapi/v2/'.$action);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $api_post);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);

Saldos

Consultar saldo

Parâmetros

Retorno

Exemplo de retorno

{
    "code": 200,
    "data": {
        "available": 300,
        "in_use": 20,
        "total": 320
    }
}

Saque em reais

Listar contas bancárias

Método para listar as contas bancárias cadastradas na Bitnuvem.

A requisição retorna um array de objetos com as informações bancárias.

Parâmetros

Esse método não possui parâmetros.

Retorno (objeto da array)

Novo saque

Parâmetros

Retorno

Código de retorno padrão.

Negociações

Nova ordem

Escolha abaixo a modalidade de ordem para acessar os parâmetros necessários.

Retorno

Caso a requisição seja bem sucedida, retornará um array no mesmo padrão do método de Consultar ordem. Saiba mais acessando a seção Código de retorno.

Consultar ordem

Parâmetros

Retorno

Exemplo de retorno

{
  "code": 200,
  "data": {
    "id": 25994945,
    "symbol": "BTCBRL",
    "create": 1683573888,
    "mode": "market",
    "type": "buy",
    "status": "completed",
    "total": 13.34,
    "amount_executed": 0.00009696,
    "orders_executed": [
      {
        "date": 1683573889,
        "price": 137684.91,
        "amount": 0.00009696,
        "fee": 1.2e-7
      }
    ]
  }
}

Listar ordens

Método para filtrar todas as ordens de uma situação específica.

A requisição tem um limite de retorno de 1000 registros.

Parâmetros

Retorno

Caso a requisição seja bem sucedida, retornará um array no mesmo padrão do método de Consultar ordem. Saiba mais acessando a seção Código de retorno.

Cancelar ordem

Método para cancelar uma ordem específica.

Parâmetros

Retorno

Código de retorno padrão.

Cancelar ordens (lote)

Método para cancelar todas as ordens abertas.

Parâmetros

Retorno

Envios de cripto

Novo envio

Retorno

Consulte a seção Código de retorno.

Taxas de rede atual

Para consultar as taxas atuais da rede, consulte a seção Taxas de envio.