Documentação da API P2P da CoinEx

Customer Specialist Team
Atualizado

Para atender às diversas necessidades de negociação dos usuários, a CoinEx agora suporta funcionalidades relacionadas à API P2P. Os detalhes são os seguintes:

 

Guia de Uso da API P2P da CoinEx

1. Usuários-alvo

Qualquer usuário que tenha concluído a verificação de ID de comerciante P2P na CoinEx. Se você ainda não é um comerciante verificado, precisa solicitar o status de comerciante P2P na página P2P antes de usar os serviços de API.

 

2. Eficiência de Execução e Conteúdo

Para usuários que operam via serviços de API, a eficiência da recuperação de informações e execução de solicitações é idêntica à da interface da CoinEx. No entanto, o conteúdo retornado pode ser truncado devido a restrições de campo.

 

3. Módulos Suportados

  • Gerenciamento de Status da Loja P2P
  • Gerenciamento de Anúncios P2P
  • Lista de Anúncios do Usuário P2P
  • Lista de Anúncios do Mercado P2P
  • Lista de Ordens P2P
  • Modificação de Preço de Anúncios P2P
  • Dados de Profundidade do Mercado P2P

 

Documentação do Endpoint da API P2P

Visite a Documentação da API Pública da CoinEx para autenticação antes de usar os endpoints abaixo.

 

1. Gerenciamento de Status da Loja P2P

Informações do Endpoint

  • Caminho URL: /v2/p2p/exchange-status
  • Método de Solicitação: POST
  • Descrição: Configurar o status de negócios da loja P2P (Aberto ou Fechado)
  • Permissão: Autenticação necessária

 

Parâmetros de Solicitação

Corpo da Solicitação

Parâmetro Obrigatório Tipo

Descrição

 
status Sim String Status da loja, opções: ABERTO ou FECHADO

 

Exemplo de Solicitação

POST /v2/p2p/exchange-status HTTP/1.1
Host: api.coinex.com
Content-Type: application/json
{
  "status": "OPEN"
}

 

Parâmetros de Resposta

Parâmetro Tipo

Descrição

 
status String O status da loja configurado, ABERTO ou FECHADO

Exemplo de Resposta

{
  "code": 0,
  "mensagem": "OK",
  "dados": {
    "status": "ABERTO"
  }
}

 

2. Gerenciamento de Anúncios P2P

Informações do Endpoint

  • Caminho URL: /v2/p2p/manage-ads
  • Método de Solicitação: POST
  • Descrição: Gerenciar anúncios P2P em lote (Online ou Offline)
  • Permissão: Autenticação necessária

 

Parâmetros de Solicitação

Corpo da Solicitação

Parâmetro Obrigatório Tipo

Descrição

 
status Sim String Tipo de operação, opções: ONLINE ou OFFLINE
ad_ids Não Matriz[String] Lista de IDs de anúncios; se não fornecido, todos os anúncios elegíveis serão operados

 

Exemplo de Solicitação

POST /v2/p2p/gerenciar-ads HTTP/1.1
Host: api.coinex.com
Tipo de conteúdo: aplicação/json
{
  "status": "ONLINE",
  "ad_ids": ["5f7c8b9d1a2b3c4d5e6f7g8h", "5f7c8b9d1a2b3c4d5e6f7g9i"]
}

 

Parâmetros de Resposta

Parâmetro Tipo

Descrição

 
IDs de anúncios afetados Matriz[String] Lista de IDs de anúncios operados com sucesso

 

Exemplo de Resposta

{
  "código": 0,
  "mensagem": "OK",
  "dados": {
    "IDs de anúncios afetados": ["5f7c8b9d1a2b3c4d5e6f7g8h", "5f7c8b9d1a2b3c4d5e6f7g9i"]
  }
}

 

3. Lista de Anúncios do Usuário P2P

Informações do Endpoint

  • Caminho URL: /v2/p2p/ads
  • Método de Solicitação: GET
  • Descrição: Recuperar todos os anúncios do usuário atual
  • Permissão: Autenticação necessária

 

Parâmetros de Solicitação

Nenhum

 

Exemplo de Solicitação

GET /v2/p2p/ads HTTP/1.1

Host: api.coinex.com

 

Parâmetros de Resposta

Retorna uma matriz de objetos de anúncios. Cada objeto de anúncio contém os seguintes campos:

Parâmetro Tipo

Descrição

 
ad_id Sequência de caracteres ID do anúncio
created_at Número  Hora de criação (em milissegundos)
atualizado_em Número Hora de atualização (em milissegundos)
número_do_anúncio String Número do anúncio
lado do anúncio String Direção do anúncio,COMPRE ou VENDA
base_ccy String Moeda base
quote_ccy String Moeda de cotação
preço String Preço
quantidade_disponível String Quantidade disponível
limite_min_de_citação String Limite mín. de negociação (moeda de cotação)
limite_máximo_de_citação String Limite máx. de negociação (moeda de cotação)
status String Status do anúncio, opções: ONLINE ou OFFLINE

 

Exemplo de Resposta

{
  "código": 0,
  "mensagem": "OK",
  "dados": [
    {
      "ad_id": "5f7c8b9d1a2b3c4d5e6f7g8h",
      "criado_em": 1618456789000,
      "atualizado_em": 1618456789000,
      "número_do_anúncio": "AD123456789",
      "lado do anúncio": "BUY",
      "base_ccy": "BTC",
      "quote_ccy": "CNY",
      "preço": "200000",
      "quantidade_disponível": "0.5",
      "limite_min_de_citação": "500",
      "citação_limite_máximot": "50000",
      "status": "ONLINE"
    },
    {
      "ad_id": "5f7c8b9d1a2b3c4d5e6f7g9i",
      "criado_em": 1618456790000,
      "atualizado_em": 1618456790000,
      "número_do_anúncio": "AD123456790",
      "lado do anúncio": "SELL",
      "base_ccy": "ETH",
      "quote_ccy": "CNY",
      "preço": "10000",
      "quantidade_disponível": "5",
      "limite_min_de_citação": "200",
      "limite_máximo_de_citação": "20000",
      "status": "OFFLINE"
    }
  ]
}

 

4. Lista de Anúncios do Mercado P2P

Informações do Endpoint

  • Caminho URL: /v2/p2p/market/ads
  • Método de Solicitação: GET
  • Descrição: Recuperar a lista de anúncios do mercado P2P
  • Permissão: Autenticação não necessária

 

Parâmetros de Solicitação

Parâmetros de Consulta

Parâmetro Obrigatório Tipo

Descrição

 
base_ccy Sim Inteiro Moeda base
quote_ccy Sim Inteiro Moeda de cotação
order_side Sim Inteiro Lado da ordem, oposto à direção do anúncio, opções: COMPRE ou VENDA
valor_da_cotação_alvo Não Decimal Quantidade de transação alvo (moeda de cotação)
ordenar por Não Inteiro Campo de classificação, padrão é PREÇO, opções: TAXA_DE_CONCLUSÃO, CONTAGEM_DE_NEGÓCIOS, TAXA_DE_ACEITAÇÃO
tipo_de_classificação Não Inteiro Tipo de classificação, ASC (ascendente) ou DESC (descendente), padrão é ASC
página Não Inteiro Número da página, padrão é 1
limite Não Inteiro Número de itens exibidos por página, padrão é 10

 

Exemplo de Solicitação

GET /v2/p2p/market/ads?base_ccy=BTC&quote_ccy=CNY&order_side=COMPRE&página=1&limite=10 HTTP/1.1

Host: api.coinex.com

 

Parâmetros de Resposta

Parâmetro Tipo

Descrição

 
data Matriz Lista de anúncios, cada estrutura é a mesma da lista de anúncios do usuário
pagination Objetivo Informações de paginação
pagination.total Inteiro Número total de registros
pagination.has_next Boolean Indica se há uma próxima página

 

Exemplo de Resposta

{
  "código": 0,
  "mensagem": "OK",
  "dados": [
        {
            "ad_id": "5f7c8b9d1a2b3c4d5e6f7g8h",
            "criado_em": 1618456789000,
            "atualizado_em": 1618456789000,
            "número_do_anúncio": "AD123456789",
            "lado do anúncio": "BUY",
            "base_ccy": "BTC",
            "quote_ccy": "CNY",
            "preço": "200000",
            "quantidade_disponível": "0.5",
            "quote_min_limit": "500",
            "quote_max_limit": "50000",
            "status": "ONLINE"
        },
    ],
    "paginação": {
      "total": 50,
      "tem_próximo": true
    }
}

 

5. Lista de Ordens P2P

Informações do Endpoint

  • Caminho URL: /v2/p2p/order
  • Método de Solicitação: GET
  • Descrição: Recuperar a lista de ordens P2P do usuário
  • Permissão: Autenticação necessária

 

Parâmetros de Solicitação

Parâmetros de Consulta

Parâmetro Obrigatório Tipo

Descrição

 
start_time Não Number Hora de início (timestamp em milissegundos)
end_time Não Number Hora de término (timestamp em milissegundos)
ad_side Não String Lado do anúncio, COMPRE ou VENDA
quote_ccy Não String Moeda de cotação
status Não string Status da ordem
página Não Integer Número da página, padrão é 1
limite Não Integer Número de itens exibidos por página, padrão é 10

 

Exemplo de Solicitação

GET /v2/p2p/order?começar_tempo=1618456789000&end_tempo=1618556789000&status=CRIADO&páfina=1&limite=10 HTTP/1.1

Host: api.coinex.com

 

Parâmetros de Resposta

Parâmetro Tipo

Descrição

 
dados Variedade Lista de ordens
paginação Objetivo Informações de paginação
paginação.total Inteiro Número total de registros
paginação.tem_próximo Boolean Indica se há uma próxima página

 

Cada objeto de ordem contém os seguintes campos:

Parâmetro Tipo

Descrição

 
id_do_pedido Inteiro ID da ordem
número_do_pedido String Número da ordem
ad_id String ID do anúncio
status String Status da ordem, opções: CRIADO, CONFIRMADO, PAGO, FINALIZADO, CANCELADO
criado_em Número Hora de criação (timestamp em milissegundos)
terminado_em Número Hora de conclusão (timestamp em milissegundos)
confirmar_devido_em Number Hora limite de confirmação (timestamp em milissegundos)
pagamento_devido_em Number Hora limite de pagamento (timestamp em milissegundos)
lado do pedido String Lado da ordem, COMPRE ou VENDA
preço String Preço
base_ccy String Moeda base
base_ccy_quantia String Quantidade de moeda base
quote_ccy String Moeda de cotação
quote_ccy_quantia String Quantidade de moeda de cotação
tipo_de_cancelamento String Tipos de cancelamento, opções:CONFIRMAR_TEMPO_LIMITE
(Comerciante não confirmou dentro do prazo), COMERCIANTE_CRIADO_CANCELAR (Comerciante recusou a ordem), CANCELAMENTO_CRIADO_PELO_CLIENTE (Usuário cancelou antes de aceitar a ordem), TEMPO_LIMITE_DE_PAGAMENTO
(Comprador não efetuou o pagamento dentro do prazo), COMPRADOR_CANCELA(Comprador cancelou a ordem), CANCELAMENTO_DE_SERVIÇO (Suporte ao cliente cancelou manualmente a ordem), CANCELAMENTO_DO_SISTEMA (Sistema cancelou automaticamente a ordem).

 

Exemplo de Resposta

{
  "código": 0,
  "mensagem": "OK",
  "dados": [
      {
        "id_do_pedido": 12345,
        "número_do_pedido": "P2P123456789",
        "ad_id": "5f7c8b9d1a2b3c4d5e6f7g8h",
        "status": "FINISHED",
        "criado_em": 1618456789000,
        "terminado_em": 1618466789000,
        "confirmar_devido_em": 1618476789000,
        "pagamento_devido_em": 1618486789000,
        "lado do pedido": "BUY",
        "preço": "200000",
        "base_ccy": "BTC",
        "base_ccy_amount": "0.1",
        "quote_ccy": "CNY",
        "quote_ccy_quantia": "20000",
        "tipo_de_cancelamento": ""
      },
    ],
    "paginação": {
      "total": 25,
      "tem_próximo": true
    }
}

 

6. Modificação de Preço de Anúncios P2P

Informações do Endpoint

  • Caminho URL: /v2/p2p/modify-ads
  • Método de Solicitação: POST
  • Descrição: Modificar preços de anúncios P2P em lote
  • Permissão: Autenticação necessária

 

Parâmetros de Solicitação

Corpo da Solicitação

Parâmetro Obrigatório Tipo

Descrição

 
ads Sim Variedade Matriz de detalhes de modificação de anúncios

 

Cada elemento na matriz ads contém os seguintes campos:

Parâmetro Obrigatório Tipo

Descrição

 
ad_id Sim String ID do anúncio
preço Sim Decimal Novo preço

 

Exemplo de Solicitação

PUBLICAR /v2/p2p/modify-ads HTTP/1.1
Host: api.coinex.com
Tipo de conteúdo: application/json
{
  "ads": [
    {
      "ad_id": "5f7c8b9d1a2b3c4d5e6f7g8h",
      "preço": "210000"
    },
    {
      "ad_id": "5f7c8b9d1a2b3c4d5e6f7g9i",
      "preço": "11000"
    }
  ]
}

 

Parâmetros de Resposta

A resposta retorna uma matriz de resultados para cada anúncio modificado. Cada elemento contém os seguintes campos:

Parâmetro Tipo

Descrição

 
código Inteiro Código do resultado, 0 indica sucesso
mensagem String Mensagem do resultado
dados Objetivo Informações do anúncio atualizado em caso de sucesso, null em caso de falha

 

Exemplo de Resposta

{
  "código": 0,
  "mensagem": "OK",
  "dados": [
    {
      "código": 0,
      "mensagem": "OK",
      "dados": {
        "ad_id": "5f7c8b9d1a2b3c4d5e6f7g8h",
        "criado_em": 1618456789000,
        "atualizado_em": 1618556789000,
        "número_do_anúncio": "AD123456789",
        "lado do anúncio": "BUY",
        "base_ccy": "BTC",
        "quote_ccy": "CNY",
        "preço": "210000",
        "quantidade_disponível": "0.5",
        "limite_min_de_citação": "500",
        "limite_máximo_de_citação": "50000",
        "status": "ONLINE"
      }
    },
    {
      "código": 11002,
      "mensagem": "adv not exists",
      "dados": null
    }
  ]
}

 

7. Dados de Profundidade do Mercado P2P

Informações do Endpoint

  • Caminho URL: /v2/p2p/market/depth
  • Método de Solicitação: GET
  • Descrição: Recuperar dados de profundidade do mercado P2P
  • Permissão: Autenticação não necessária

 

Parâmetros de solicitação

Parâmetros de Consulta

Parâmetro Obrigatório Tipo

Descrição

 
base_ccy Sim String Moeda base
quote_ccy Sim String Moeda de cotação

 

Exemplo de Solicitação

GET /v2/p2p/mercado/profundidade?base_ccy=BTC&quote_ccy=CNY HTTP/1.1

Host: api.coinex.com

 

Parâmetros de Resposta

Parâmetro Tipo

Descrição

 
base_ccy String Moeda base
quote_ccy String Moeda de cotação
índice_preço String Preço de índice
profundidade Objetivo Dados de profundidade
lances de profundidade Variedade Dados de profundidade
profundidade.perguntas Variedade Profundidade de ordens de venda

 

Cada elemento nas matrizes de profundidade contém os seguintes campos:

Parâmetro Tipo

Descrição

 
preço String Preço
quantia String Quantidade

 

Exemplo de Resposta

{
  "código": 0,
  "mensagem": "OK",
  "dados": {
    "base_ccy": "BTC",
    "quote_ccy": "CNY",
    "index_price": "200000",
    "profundidade": {
      "lances": [
        {
          "preço": "199000",
          "quantia": "1.5",
        },
        {
          "preço": "198000",
          "quantia": "2.0",
        }
      ],
      "pergunta": [
        {
          "preço": "201000",
          "quantia": "1.0",
        },
        {
          "preço": "202000",
          "quantia": "1.8",
        },
      ]
    }
  }
}
 

Aviso: O conteúdo fornecido neste site é apenas para fins informativos e não constitui aconselhamento de investimento. As informações fornecidas não pretendem substituir conselhos, consultas ou recomendações financeiras profissionais. Os usuários são incentivados a contatar um consultor financeiro qualificado antes de tomar qualquer decisão de investimento. Os proprietários e autores do website não assumem qualquer responsabilidade por quaisquer perdas ou danos que possam resultar da confiança nas informações fornecidas. Todos os investimentos acarretam riscos e o desempenho passado não é indicativo de resultados futuros.