API

Início

Os dados submetidos devem estar em codificação UTF-8.
Para pedidos API bem-sucedidos, todos os pedidos devem conter vários cabeçalhos obrigatórios:
- O cabeçalho X-API-KEY deve conter a sua Chave API recebida (YOUR_API_KEY)

Exemplo de pedido

bash

curl -X GET \
-H "x-api-key: YOUR_API_KEY" \
"https://xgram.io/api/v1/METHOD"

Todas as requisições enviadas para a API Xgram devem incluir o parâmetro key (chave da API), disponível após o cadastro no nosso Programa de Parcerias.

Validação de Endereço

Esta requisição verifica a validade do endereço:

https://xgram.io/api/v1/crypto-address-verification

Parâmetro

Tipo

Exemplo

cryptoDigitalCoin

string

BTC

cryptoDigitalAddress

string

bc1q6aas41krwvvcc4hhio6u4euf1y3wkbtap8uhmrt

Exemplo de pedido

bash

curl -X GET "https://xgram.io/api/v1/crypto-address-verification?cryptoDigitalCoin=BTC&cryptoDigitalAddress=bc1q6aas41krwvvcc4hhio6u4euf1y3wkbtap8uhmrt" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Exemplo de resposta

json

{

"result": true

}

Taxa de câmbio para o valor da transação

Esta requisição obtém a taxa de câmbio atual. A taxa de transação não está incluída:

https://xgram.io/api/v1/retrieve-rate-value

Parâmetro

Tipo

Exemplo

fromCcy

string

BTC

toCcy

string

ETH

ccyAmount

float

Exemplo de pedido

bash

curl -X GET "https://xgram.io/api/v1/retrieve-rate-value?fromCcy=BTC&toCcy=ETH&ccyAmount=1" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Exemplo de resposta

json

{

"fix": false,

"minFrom": "0.0081",

"maxFrom": "138",

"from_network": "Bitcoin",

"to_network": "ERC20",

"rate": 25.084395813448847,

"withdrawalFee": "0.006 ETH",

"result": true

}

* withdrawalFee - Taxa de saque aproximada. Parâmetro flutuante.

Obter lista de moedas

Obter todas as moedas habilitadas:

https://xgram.io/api/v1/list-currency-options

Exemplo de pedido

bash

curl -X GET "https://xgram.io/api/v1/list-currency-options" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Exemplo de resposta

json

{

"XETA": {

"coinName": "XANA",

"contract": "0x111111111117dc0aa78b770fa6a738034120c302",

"minFrom": 19137.93103448276,

"maxFrom": 18773946,

"tagname": "",

"network": "AVAXC",

"available": true

"FITFI": {

"coinName": "Step App",

"contract": "",

"minFrom": 16989.79591836735,

"maxFrom": 14965986,

"tagname": "",

"network": "AVAXC",

"available": true

"ARB": {

"coinName": "Arbitrum",

"contract": "",

"minFrom": 90.68627450980394,

"maxFrom": 88085,

"tagname": "",

"network": "Arbitrum",

"available": true

"KLAY": {

"coinName": "Klaytn",

"contract": "",

"minFrom": 389.9297423887589,

"maxFrom": 69838833,

"tagname": "",

"network": "Klaytn",

"available": true

...

}

Se o tagname não for um valor vazio, a tag é um parâmetro obrigatório para esta moeda.

Lista de Pares

Esta requisição obtém todos os pares disponíveis para troca:

https://xgram.io/api/v1/load-pairs-options

Exemplo de pedido

bash

curl -X GET "https://xgram.io/api/v1/load-pairs-options" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Exemplo de resposta

json

[

  [
    "ETH",
    "LTC"   
  ],

  [
     "BTC",
     "BCH"
  ],

  [
    "ZEC",
    "BAT"
  ],

  [
    "ETH",
    "USDT"
  ],

  [
    "BNB",
    "XRP"
  ],
]

Início da Troca

Esta requisição cria – inicia – a troca:

https://xgram.io/api/v1/launch-new-exchange

Parâmetro

Tipo

Exemplo

toAddress

string

0xaeeee8f61f3ccffe8c60e7aed0f4ca753e0ba43d

toAddressTag

opcional

string

refundAddress

opcional

string

bc1q8dj6psgvmqshkgy9vpl7shtn2ly77qz5dr6mq3

refundTag

opcional

string

fromCcy

string

BTC

toCcy

string

ZEC

ccyAmount

float

0.5

type

opcional

string

float

Valores válidos: float e fixed

Exemplo de pedido

bash

curl -X GET "https://xgram.io/api/v1/launch-new-exchange?toAddress=0x750c44dB01899176f2e64bD25A2fabAC1140d8e9&fromCcy=BTC&toCcy=ETH&ccyAmount=0.5" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Exemplo de resposta

json

{

"id": "qeqb36r5qa999th0",

"depositAddress": "2Q4J7Kz90S6yI5fWb1T8LzR9U3eM4vXxC7H",

"depositTag": "",

"result": true,

"ccyAmountToExpected": 14.7316,

}

Início do Pagamento

Esta requisição cria – inicia – o pagamento:

https://xgram.io/api/v1/launch-new-payment-exchange

Parâmetro

Tipo

Exemplo

toAddress

string

0xaeeee8f61f3ccffe8c60e7aed0f4ca753e0ba43d

toAddressTag

opcional

string

refundAddress

opcional

string

bc1q8dj6psgvmqshkgy9vpl7shtn2ly77qz5dr6mq3

refundTag

opcional

string

fromCcy

string

BTC

toCcy

string

ZEC

ccyAmount

float

0.5

type

opcional

string

float

Valid values: float and fixed

Exemplo de pedido

bash

curl -X GET "https://xgram.io/api/v1/launch-new-payment-exchange?toAddress=0x750c44dB01899176f2e64bD25A2fabAC1140d8e9&fromCcy=BTC&toCcy=ETH&ccyAmount=0.5" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Exemplo de resposta

json

{

"id": "qeqb36r5qa999th0",

"depositAddress": "2Q4J7Kz90S6yI5fWb1T8LzR9U3eM4vXxC7H",

"depositTag": "",

"result": true,

"ccyAmountFrom": 0.0183883

}

Obter status da troca

Obter informações sobre o status atual da troca:

https://xgram.io/api/v1/fetch-status-info

Parâmetro

Tipo

Exemplo

string

qeq6r5qa999th0

Exemplo de pedido

bash

curl -X GET "https://xgram.io/api/v1/fetch-status-info?id=qeq6r5qa999th0" \

-H "x-api-key: bc1qvi55hg9rlwc2etpoypkt98db37vcbto5fke0a6w" \

-H "Content-Type: application/json; charset=UTF-8"

Exemplo de resposta

json

{

"x-status": "deposit_received",

"id": "qeq6r5qa999th0",

"x-fromCcy": "BTC",

"x-toCcy": "ZEC",

"x-ccyDepositAddress": "1Z9VcAgLPQwoAb7fiWuDKZbqwnt5LKrAv",

"x-ccyDepositTag": "",

"x-ccyDepositHash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2g3h",

    "x-ccyDestinationAddress":

"2Q4J7Kz90S6yI5fWb1T8LzR9U3eM4vXxC7H",

"x-ccyDestinationTag": "",

    "x-ccyRefundAddress":

"2B2yQ2fQ6RHejg3ENQUgUM6TMn8e8WjGqOb",

"x-ccyRefundTag": "",

"x-ccyExpectedAmountFrom": 0.5,

"x-ccyExpectedAmountTo": 50.02,

"x-ccyAmountFrom": "0.5",

"date": "21.01.2024 10:01:11",

"txId": null,

"x-ccyAmountTo": null,

"result": true

}

Lista de status utilizados:
x-new - nova transação (aguardando depósito)
x-awaiting_funds - depósito em confirmação
x-funds_received - depósito recebido
x-processing_exchange - em processo de troca
x-transferring - em processo de envio
x-completed - troca concluída com sucesso
x-timeout - o tempo de espera pelos fundos expirou
x-error - a troca terminou com erro
x-transfer_error - tentativa de envio falhou
x-returned - os fundos foram devolvidos ao cliente