API de Negociações v1.0Documentação

Nossa API de Negociação permite aplicativo de terceiros a gerenciar suas ordens, efetuar saques de reais e bitcoins .

URL para acesso:

https://bitnuvem.com/tapi/{MÉTODO}

Autenticação

Para acessar a API de Negociações é necessário gerar as chaves privadas de acesso. Ao solicitar qualquer método sempre envie:

Parâmetros POST
VariávelTipoDescrição
api_keyTextoChave da API disponível no painel do usuário
request_bodyTextoParâmetros da requisição que será feita em formato URL (query)
signatureTexto'request_body' criptografada em HMAC SHA-256 com a chave secreta sendo o 'Segredo' fornecido no momenta da criação da nova chave
Para toda requisição é obrigatório o envio do parâmetro 'timestamp' no 'request_body' com a data atual em formato Unix Timestamp

Métodos disponíveis

balance

https://bitnuvem.com/tapi/balance

Exibe o seu saldo total, disponível e em uso de todas os valores de sua conta.

Exemplo de retorno:

{
    "total": {
        "REAL": "6195.84",
        "BTC": "0.73764924"
    },
    "available": {
        "REAL": "4586.58",
        "BTC": "0.73664924"
    },
    "in_use": {
        "REAL": "1609.26",
        "BTC": "0.00100000"
    }
}
Parâmetros POST
VariávelTipoDescrição
totalArrayArray contendo lista de valores totais
availableArrayArray contendo lista de valores disponíveis
in_useArrayArray contendo lista de valores em uso (ordem em aberto e/ou saque pendente)

account_bank_list

https://bitnuvem.com/tapi/account_bank_list

Método para obter todos as contas bancárias cadastrados em sua conta.

Exemplo de retorno:

[
    {
        "id": "115",
        "cpf_cnpj": "30.546.114/0001-00",
        "bank": "Banco do Brasil",
        "agency": "1234",
        "account": "56.789",
        "account_type": "Corrente",
        "account_name": "Lucas Ribeiro do Prado",
        "account_digit": "X"
    }
]
account_bank_list
VariávelTipoDescrição
idInteiroIdentificador do banco
bankTextoBanco que pertence a conta
agencyTextoAgência da conta bancária
agency_digitTextoDigito da agência da conta bancária
accountTextoNúmero da conta bancária
account_digitTextoDigito do número da conta bancária
account_typeTextoTipo da conta (Corrente ou Poupança)
cpf_cnpjTextoCPF ou CNPJ do proprietário da conta
account_nameTextoNome do proprietário da conta
operationTextoOperação da conta (somente para clientes Caixa)

withdraw

https://bitnuvem.com/tapi/withdraw

Método para solicitar um saque em reais.

Parâmetros POST
VariávelTipoDescrição
valueDecimalValor em reais desejado para saque
bank_idInteiroIndentificador do banco

Retorno:

Clique aqui para ver os posíveis código de retorno.

send

https://bitnuvem.com/tapi/send

Método para enviar Bitcoins para um endereço.

Parâmetros POST
VariávelTipoDescrição
amountDecimalValor em bitcoin desejado para envio
addressTextoEndereço que deseja enviar as moedas

Retorno:

Clique aqui para ver os posíveis código de retorno.

order_get

https://bitnuvem.com/tapi/order_get

Método para retornar uma ordem específica.

Parâmetros POST
VariávelTipoDescrição
order_idTextoIdentificador da ordem
Retorno de 'order_list', 'order_get' e 'order_new'
VariávelTipoDescrição
idTextoIdentificador da ordem
createInteiroData da ordem criada em formato Unix Timestamp
modeTextoModo da ordem: 'limit' (limite) ou 'market' (mercado)
typeTextoTipo da ordem: 'sell' (venda) ou 'buy' (compra)
statusTextoSituações da ordem: 'active' (ativas), 'completed' (concluídas), 'canceled' (canceladas)
triggerTextoTipo do gatilho: 'stop' ou 'oco'
trigger_priceDecimalPreço inserido no gatilho
amountDecimalQuantidade de Bitcoins sendo negociado
priceDecimalPreço únitário em reais do Bitcoin negociado
totalDecimalPreço total em reais negocidado

order_list

https://bitnuvem.com/tapi/order_list

Método para retornar todas as ordens de uma situação específica cadastrada em sua conta.

Parâmetros POST
VariávelTipoDescrição
statusTextoSituação: 'all' (todas), 'active' (ativas), 'completed' (concluídas) ou 'canceled' (canceladas)

Retorno para sucesso:

Retorna detalhes da ordem criada em uma array (ver order_get).

order_new

https://bitnuvem.com/tapi/order_new

Método para lançar novas ordens no livro de ofertas.

Ordens no modo 'Limite'
VariávelTipoDescrição
modeTextoModo da ordem: 'limit'
typeTextoTipo da ordem: 'buy' (compra) ou 'sell' (venda)
amountDecimalQuantidade de Bitcoin a ser negociado
priceDecimalPreço unitário em reais do Bitcoin negociado
price_stopDecimalPreço unitário em reais do Bitcoin para gatilho 'stop' (opcional)
price_ocoDecimalPreço unitário em reais do Bitcoin para gatilho 'oco' (opcional)
Ordens no modo 'Mercado'
VariávelTipoDescrição
modeTextoModo da ordem: 'market'
typeTextoTipo da ordem: 'buy' (compra) ou 'sell' (venda)
amountDecimalQuantidade de Bitcoin a ser negociado (somente para venda)
totalDecimalTotal em reais que deseja comprar de Bitcoin (somente para compra)
price_stopDecimalPreço unitário em reais do Bitcoin para gatilho 'stop' (opcional)
Ordens no modo 'Escalonado'
VariávelTipoDescrição
modeTextoModo da ordem: 'scale'
typeTextoTipo da ordem: 'buy' (compra) ou 'sell' (venda)
amountDecimalQuantidade de Bitcoin a ser negociado (somente para venda)
totalDecimalTotal em reais que deseja comprar de Bitcoin (somente para compra)
type_scaleTextoTipo da distribuição: 'equal' (igualmente), 'asc' (crescente) ou 'desc' (descrescente)
number_ordersInteiroNúmero de ordens que deseja distribuir a negociação
price_minDecimalPreço mínimo unitário em reais do Bitcoin para distribuição nas ordens
price_maxDecimalPreço máximo unitário em reais do Bitcoin para distribuição nas ordens

Retorno para sucesso:

Retorna detalhes da ordem criada em uma array (ver order_get).

Retorno para erro:

Clique aqui para ver os posíveis código de retorno.

order_cancel

https://bitnuvem.com/tapi/order_cancel

Método para cancelar uma ordem específica.

Parâmetros POST
VariávelTipoDescrição
order_idTextoIdentificador da ordem

Retorno:

Clique aqui para ver os posíveis código de retorno.

order_cancel/all

https://bitnuvem.com/tapi/order_cancel/all

Método para cancelar todas as ordens abertar.

Parâmetros POST
VariávelTipoDescrição
typeTextoCancelar um tipo espefíco: 'sell' (vendas), 'buy' (compras) ou 'all' (todas)

Exemplo de retorno:

Clique aqui para ver os posíveis código de retorno.