API

Başlangıç

Gönderilen veriler UTF-8 kodlamasında olmalıdır.
Başarılı API istekleri için tüm isteklerde birkaç zorunlu header bulunmalıdır:
- X-API-KEY header’ı aldığınız API Key’i içermelidir (YOUR_API_KEY)

Örnek istek

bash

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

Xgram API’ye gönderilen tüm istekler, Ortaklık Programımıza kaydolduktan sonra erişilebilen key (API anahtarı) parametresini içermelidir.

Adres Doğrulama

Bu istek, adresin geçerliliğini kontrol eder:

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

Parametre

Tür

Örnek

cryptoDigitalCoin

string

BTC

cryptoDigitalAddress

string

bc1q6aas41krwvvcc4hhio6u4euf1y3wkbtap8uhmrt

Örnek istek

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"

Örnek yanıt

json

{

"result": true

}

İşlem tutarı için döviz kuru

Bu istek, güncel döviz kurunu alır. İşlem ücreti dahil değildir:

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

Parametre

Tür

Örnek

fromCcy

string

BTC

toCcy

string

ETH

ccyAmount

float

Örnek istek

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"

Örnek yanıt

json

{

"fix": false,

"minFrom": "0.0081",

"maxFrom": "138",

"from_network": "Bitcoin",

"to_network": "ERC20",

"rate": 25.084395813448847,

"withdrawalFee": "0.006 ETH",

"result": true

}

* withdrawalFee - Yaklaşık çekim ücreti. Değişken parametre.

Para birimi listesini al

Etkin olan tüm para birimlerini al:

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

Örnek istek

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"

Örnek yanıt

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

...

}

tagname boş bir değer değilse, bu etiket ilgili para birimi için zorunlu bir parametredir.

Parite Listesi

Bu istek, takas için kullanılabilir tüm pariteleri alır:

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

Örnek istek

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"

Örnek yanıt

json

[

  [
    "ETH",
    "LTC"   
  ],

  [
     "BTC",
     "BCH"
  ],

  [
    "ZEC",
    "BAT"
  ],

  [
    "ETH",
    "USDT"
  ],

  [
    "BNB",
    "XRP"
  ],
]

Takas Başlatma

Bu istek, takası oluşturur ve başlatır:

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

Parametre

Tür

Örnek

toAddress

string

0xaeeee8f61f3ccffe8c60e7aed0f4ca753e0ba43d

toAddressTag

opsiyonel

string

refundAddress

opsiyonel

string

bc1q8dj6psgvmqshkgy9vpl7shtn2ly77qz5dr6mq3

refundTag

opsiyonel

string

fromCcy

string

BTC

toCcy

string

ZEC

ccyAmount

float

0.5

type

opsiyonel

string

float

Geçerli değerler: float ve fixed

Örnek istek

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"

Örnek yanıt

json

{

"id": "qeqb36r5qa999th0",

"depositAddress": "2Q4J7Kz90S6yI5fWb1T8LzR9U3eM4vXxC7H",

"depositTag": "",

"result": true,

"ccyAmountToExpected": 14.7316,

}

Ödeme Başlatma

Bu istek, ödemeyi oluşturur ve başlatır:

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

Parametre

Tür

Örnek

toAddress

string

0xaeeee8f61f3ccffe8c60e7aed0f4ca753e0ba43d

toAddressTag

opsiyonel

string

refundAddress

opsiyonel

string

bc1q8dj6psgvmqshkgy9vpl7shtn2ly77qz5dr6mq3

refundTag

opsiyonel

string

fromCcy

string

BTC

toCcy

string

ZEC

ccyAmount

float

0.5

type

opsiyonel

string

float

Valid values: float and fixed

Örnek istek

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"

Örnek yanıt

json

{

"id": "qeqb36r5qa999th0",

"depositAddress": "2Q4J7Kz90S6yI5fWb1T8LzR9U3eM4vXxC7H",

"depositTag": "",

"result": true,

"ccyAmountFrom": 0.0183883

}

Takas durumunu alma

Mevcut takas durumu hakkında bilgi alma:

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

Parametre

Tür

Örnek

string

qeq6r5qa999th0

Örnek istek

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"

Örnek yanıt

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

}

Kullanılan durumların listesi:
x-new - yeni işlem (yatırma bekleniyor)
x-awaiting_funds - yatırma onaylanıyor
x-funds_received - yatırma alındı
x-processing_exchange - takas işlemi devam ediyor
x-transferring - gönderim sürecinde
x-completed - takas başarıyla tamamlandı
x-timeout - fonlar için bekleme süresi doldu
x-error - takas bir hata ile sonuçlandı
x-transfer_error - gönderim denemesi başarısız oldu
x-returned - fonlar kullanıcıya iade edildi