Endpoint de API

Todas as tuas requisições de API devem ser feitas para o seguinte endpoint de API:

https://api.cryptohopper.com/v1/

Métodos de Request Suportados

Parâmetros de Requisição

Tem quatro tipos de parâmetros que usamos na nossa API: path, query string, cabeçalho e parâmetros do corpo da requisição. Os parâmetros do corpo da requisição são dados enviados no corpo da requisição JSON para requisições POST e PATCH. Os parâmetros de cabeçalho são, obviamente, parâmetros que precisam ser enviados no cabeçalho. Mais informações sobre os parâmetros de Cabeçalho, Path e Query string estão abaixo.

Parâmetros de Cabeçalho

Toda requisição para nossa API precisa ser autenticada enviando os seguintes valores no cabeçalho:

• access-token - Seu token de acesso recebido com a autenticação OAuth2.

Parâmetros de Caminho

Estes são parâmetros fornecidos no URI do endpoint. Por exemplo, o endpoint GET Hopper:

https://api.cryptohopper.com/v1/hopper/{hopper_id}

Para recuperar um robô de negociação pelo seu ID único, precisa substituir o valor do seu ID no placeholder {hopper_id}. Por exemplo, para recuperar um robô de negociação com o ID 37, você requisitaria o seguinte URL:

https://api.cryptohopper.com/v1/hopper/37

Alguns endpoints exigem múltiplos parâmetros. Por exemplo, se quiseres retornar um pedido específico do Hopper anterior, precisas chamar a seguinte URL:

https://api.cryptohopper.com/v1//hopper/{hopperId}/order/{orderId}

E substituindo os parâmetros pelo Hopper e ID da ordem, je conseguirá:

https://api.cryptohopper.com/v1//hopper/37/order/231

Para uma lista detalhada dos parâmetros requeridos em cada endpoint da API, consulta nosso guia de referência da API.

Parâmetros da Query String

Usamos esses tipos de parâmetros em requisições GET para filtragem e/ou paginação de dados. Esses parâmetros não são especificados no caminho, mas como um conjunto de valores separados pelo caractere ‘&' na string da URL.

Por exemplo, para pegar as ordens de compra de Bitcoin de um robô de trading, je pode chamar a endpoint Hopper Order assim:

https://api.cryptohopper.com/v1/hopper/37/order/?order_type=buy&coin=btc
        

Olhando nossa referência de API, je percebe que, nesse caso, o parâmetro order_type pode receber os valores 'compra' ou 'venda', e o parâmetro coin pode ser qualquer código de moeda criptografada em minúsculo.

Formato de Resposta

Todas as respostas estão no formato de um objeto JSON. Portanto, o tipo MIME que encontras em todas as nossas respostas será application/json. Consulta a nossa documentação de referência da API para o formato específico de resposta JSON no corpo de cada requisição e resposta.

Códigos de Resposta HTTP

Usamos os códigos de status de resposta definidos pelos padrões RFC 2616 e RFC 6585..

Códigos de Erro HTTP

Mensagens de erro

Sempre que a API retornar um código de erro, vai anexar um objeto JSON com a descrição do erro no corpo. Uma mensagem de erro ficaria assim:

{
            "status": 400,
            "error": 1,
            "message": "Missing required request parameters: [access_token]"
        }
        

Limites de Taxa

Nossa API tem um limite de requisições para distribuir os recursos de banda de maneira justa para todos os usuários. Os limites atuais são de 2 requisições por segundo por usuário, exceto para a colocação de ordens de compra. Nesse caso, o máximo de ordens de compra que podem ser colocadas é uma a cada 8 segundos.

Se você ultrapassar o número de requisições por segundo disponíveis, receberá um código de resposta de erro 429. Verifique o cabeçalho Retry-After incluído na resposta, que contém o tempo em segundos que você precisa esperar para fazer outra requisição.