RESTful API

Получить адрес контракта

GET https://api.zks.app/v2/:network/contract-address

Возвращает контракты, используемые для депозита и т.д. В большинстве случаев ответ не меняется.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для Ropsten...

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для Ropsten...

{
    "success": true,
    "data": {
        "gov": "0x86E527BC3C43E6Ba3eFf3A8CAd54A7Ed09cD8E8B",
        "main": "0x6dE5bDC580f55Bc9dAcaFCB67b91674040A247e3"
    }
}

Получить список токенов

GET https://api.zks.app/v2/:network/tokens

Возвращает все токены, которые залистились на ZKSwap.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для Ropsten...

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для Ropsten...

{
    "success": true,
    "data": [
        {
            "id": 0,
            "address": "0x0000000000000000000000000000000000000000",
            "decimals": 18,
            "symbol": "ETH",
            "icon": "https://s.zks.app/icons/v2/0x0000000000000000000000000000000000000000.png",
            "approved": true
        },
        {
            "id": 10,
            "address": "0xe4815ae53b124e7263f08dcdbbb757d41ed658c6",
            "decimals": 18,
            "symbol": "ZKS",
            "icon": "https://s.zks.app/icons/v2/0xe4815ae53b124e7263f08dcdbbb757d41ed658c6.png",
            "approved": true
        },
        {
            "id": 32,
            "address": "0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9",
            "decimals": 18,
            "symbol": "AAVE",
            "icon": "https://s.zks.app/icons/v2/0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9.png",
            "approved": true
        }
    ]
}

Ниже представлена схема для одного из токенов.

Field

Type

Comment

number

The unique ID starting from 0, which is native coin.

address

Native coin's address is 0x0000000000000000000000000000000000000000

decimals

number

The number of decimals used to get its user representation.

symbol

string

The unique symbol indicates the symbol.

icon

string

The image url shows the icon.

Получить цены токенов

GET https://api.zks.app/v2/:network/tokens/price

Возвращает все цены токенов с ZKSwap.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для Ropsten...

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для Ropsten...

{
    "success": true,
    "data": [
        {
            "id": 0,
            "price": "2968.1483043140707263"
        },
        {
            "id": 10,
            "price": "0.7862725980605806"
        },
        {
            "id": 32,
            "price": "0"
        }
    ]
}

Field

Type

Comment

number

The unique ID.

price

string

The unit is USD.

Получить список торговых пар

GET https://api.zks.app/v2/:network/pairs

Возвращает все торговые пары, которые были добавлены на ZKSwap.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для Ropsten...

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для Ropsten...

{
    "success": true,
    "data": [
        {
            "id": 16384,
            "address": "0xda097aa54e44e389f2acadb69027c8780a8ec852",
            "decimals": 18,
            "symbol": "liquidity_10_32",
            "id_a": 10,
            "id_b": 32,
            "anchored": 10
        },
        {
            "id": 16385,
            "address": "0x9c883156e724ceb48d230da0132fab4aa721ae84",
            "decimals": 18,
            "symbol": "liquidity_8_10",
            "id_a": 8,
            "id_b": 10,
            "anchored": 8
        },
        {
            "id": 16386,
            "address": "0xaa45c964e21eafb38574e9d000adbaf85acfbb80",
            "decimals": 18,
            "symbol": "liquidity_0_10",
            "id_a": 0,
            "id_b": 10,
            "anchored": 0
        }
    ]
}

Field

Type

Comment

number

The unique ID starting from 16384.

address

It's the same as the LP token on Layer-1.

decimals

number

The number of decimals used to get its user representation, it's always 18.

symbol

string

The unique symbol follows the format liquidity_{idA}_{idB}.

id_a

string

The ID of token A.

id_b

string

The ID of token B.

Получить цены торговых пар

GET https://api.zks.app/v2 /:network/pairs/price

Возвращает цены всех торговых пар с ZKSwap.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для Ropsten...

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для Ropsten...

{
    "success": true,
    "data": [
        {
            "id": 16384,
            "amount_a": "0",
            "amount_b": "0",
            "price": "0",
            "totalSupply": "0"
        },
        {
            "id": 16385,
            "amount_a": "1464474.697055",
            "amount_b": "1859053.645591589842522106",
            "price": "1782999.9600978410438763",
            "totalSupply": "1.642708614502310855"
        },
        {
            "id": 16386,
            "amount_a": "33.667299246695146243",
            "amount_b": "127772.687849889681268329",
            "price": "96.778364123199939",
            "totalSupply": "2065.121436478357148901"
        }
    ]
}

Field

Type

Comment

number

The unique ID.

amount_a

string

The formatted amount of token A in the pair (also known as reverse0).

amount_b

string

The formatted amount of token B in the pair (also known as reverse1).

price

string

The number indicates how much 1 LP token values.

totalSupply

string

Получить баланс учетной записи

GET https://api.zks.app/v2/:network/account/:address/balances

Возвращает баланс указанного адреса. Если по адресу нет токена/пары, то баланс не будет возвращен. Все стоимости активов указаны в USD.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для Ropsten...
address	string	Адрес учетной записи без учета регистра.

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для Ropsten...

address

string

Адрес учетной записи без учета регистра.

{
    "success": true,
    "data": {
        "balances": {
            "tokens": [
                {
                    "id": 8,
                    "amount": "14.918202",
                    "Value": "0"
                },
                {
                    "id": 10,
                    "amount": "720651.4115822",
                    "Value": "0"
                },
                {
                    "id": 32,
                    "amount": "0.6027962441",
                    "Value": "0"
                }
            ],
            "pairs": [
                {
                    "id": 16385,
                    "amount": "0.000294957624075052",
                    "Value": "523.4426987137814436216811147071194148"
                },
                {
                    "id": 16387,
                    "amount": "0.000004427188724235",
                    "Value": "482.09321566002294012027060109989963"
                }
            ]
        },
        "asset": {
            "tokens": "562353.0359099654094174914699",
            "pairs": "1005.5359143738043837419517158070190448",
            "total": "563358.5718243392138012334216158070190448"
        }
    }
}

Получить информацию об учетной записи

GET https://api.zks.app/v2/:network/account/:address/info

Возвращает id, nonce и pubKeyHash учетной записи. Если у учетной записи нет никаких активов на ZKSwap, то id будет 0.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для Ropsten...
address	string	Адрес учетной записи без учета регистра.

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для Ropsten...

address

string

Адрес учетной записи без учета регистра.

{
    "success": true,
    "data": {
        "id": 2,
        "nonce": 1256,
        "pub_key_hash": "sync:e4762290aa804636fd63ee25fe91497a8ea01dea"
    }
}

Получить комиссии учетной записи

GET https://api.zks.app/v2/:network/account/:address/fee

Все комиссии в USD.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для сети Ropsten
address	string	Адрес учетной записи без учета регистра

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для сети Ropsten

address

string

Адрес учетной записи без учета регистра

{
    "success": true,
    "data": {
        "transfer": "0",
        "withdraw": "5",
        "add_liquidity": "0",
        "remove_liquidity": "0"
    }
}

Получить список транзакций

GET https://api.zks.app/v2/:network/txs

Возвращает список транзакций.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для Ropsten...

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для Ropsten...

Query Parameters

Name	Type	Description
address	string	Адрес транзакции. При этом не важно - это отправитель или получатель.
types	string	Список типов, разделенных знаком \| . Ниже указаны все типы. Напр. AddLiquidity\|RemoveLiquidity
token	number	Уникальный идентификатор токена.
start	number	По умолчанию 0.
limit	number	По умолчанию 50. Максимум 50.

Name

Type

Description

address

string

Адрес транзакции. При этом не важно - это отправитель или получатель.

types

string

Список типов, разделенных знаком | . Ниже указаны все типы. Напр. AddLiquidity|RemoveLiquidity

token

number

Уникальный идентификатор токена.

start

number

По умолчанию 0.

limit

number

По умолчанию 50. Максимум 50.

{
    "success": true,
    "data": {
        "pagination": {
            "total": 2,
            "start": 0,
            "limit": 100
        },
        "data": [
            {
                "amount": "2",
                "block_number": 1920,
                "created_at": 1628344581,
                "fail_reason": "",
                "fee": "0",
                "fee_token": 0,
                "fee_value": "0",
                "from": "0x961b513dfd3e363c238e0f98219ee02552a847bd",
                "id": 6014,
                "nonce": 1252,
                "status": "verified",
                "success": true,
                "to": "0x1c65291ba1c67b539d6f957fcc2f1944c146dbc9",
                "token": {
                    "id": 10,
                    "symbol": "ZKS"
                },
                "tx_hash": "0x3dca53000392ff1fc059f40b0a64a247d94bd7d46ec05397da13aaf592cb902e",
                "tx_type": "Transfer",
                "value": "1.72841"
            },
            {
                "amount": {
                    "amount": "0.000004427188724235",
                    "amount_a": "0.1",
                    "amount_b": "196"
                },
                "block_number": 14,
                "created_at": 1626329003,
                "fail_reason": "",
                "fee": "0",
                "fee_token": 8,
                "fee_value": "0",
                "from": "0x961b513dfd3e363c238e0f98219ee02552a847bd",
                "id": 19,
                "nonce": 2,
                "status": "verified",
                "success": true,
                "to": "0x2e35bb0d1570b1fb816255974a21b375cefe1eca",
                "token": {
                    "id": 16387,
                    "id_a": 0,
                    "id_b": 8,
                    "symbol_a": "ETH",
                    "symbol_b": "USDT"
                },
                "tx_hash": "0x42453836dbe9689a75be663534a5c3de73901c38c56defb406b9135a510625b2",
                "tx_type": "AddLiquidity",
                "value": "392"
            }
        ]
    }
}

Каждая транзакция содержит следующие поля:

Field

Type

Comment

tx_hash

string

The hash of the transaction.

tx_type

string

One of the following: Deposit, Transfer, Withdraw, Swap, AddLiquidity and RemoveLiquidity.

status

string

pending or verified

from

address

The transaction sender.

address

The transaction receiver. For Swap, AddLiquidity and RemoveLiquidity, the receiver is the pair address.

token

object

It always contains id. For Swap, AddLiquidity and RemoveLiquidity, it contains id_a and id_b.

amount

mixed

For Deposit, Withdraw and Transfer, it's the formatted amount. For other type, it's an object contains amount_a and amount_b.

value

string

The value of transaction in USD.

fee_token

number

The ID of transaction fee token.

fee

string

The transaction fee.

fee_value

string

The value of transaction fee in USD.

block_number

number

The block it belongs.

created_at

number

The UNIX timestamp when the transaction created.

success

boolean

Indicates the transaction is successful or not.

fail_reason

string

Only contains message when transaction failed.

nonce

number

Similar with ETH's nonce.

Получить транзакцию

GET https://api.zks.app/v2/:network/tx/:tx_hash

Возвращает данные транзакции.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для Ropsten...
tx_hash	string	Хэш транзакции.

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для Ropsten...

tx_hash

string

Хэш транзакции.

{
    "success": true,
    "data": {
        "id": 586433,
        "tx_hash": "0x9073df41def307564a8cd569cbae0c2a813b4c3d5f692e1a3a8323b7fab42d2d",
        "tx_type": "AddLiquidity",
        "status": "verified",
        "from": "0xd6e1e53465f50d4b1a8294b052e5f972fba5ebe4",
        "to": "0x5c7d7683758b449c11fcbd68da4e9a5398073f35",
        "token": {
            "id": 213,
            "id_a": 30,
            "id_b": 29,
            "symbol_a": "BUSD",
            "symbol_b": "USDT"
        },
        "amount": {
            "amount": "0.000261185806411614",
            "amount_a": "261.08086447",
            "amount_b": "261.495942"
        },
        "value": "522.99188",
        "fee": "0",
        "fee_value": "0",
        "fee_b": "0",
        "fee_b_value": "0",
        "block_number": 41440,
        "created_at": 1617298650,
        "success": true,
        "fail_reason": "",
        "nonce": 10
    }
}

Отправить транзакцию

POST https://api.zks.app/v2/:network/tx

Отправляет транзакцию на Уровень 2 в ZKSwap. Возвращает хеш транзакции, если она была принята.

Path Parameters

Name	Type	Description
network	number	Номер сети: 1 для основной сети, 3 для Ropsten...

Name

Type

Description

network

number

Номер сети: 1 для основной сети, 3 для Ropsten...

Request Body

Name	Type	Description
tx	number	Подписанные данные транзакции
signature	object	Подпись для Уровня 1. Для ChangePubKey должен быть null
fastProcessing	boolean	null

Name

Type

Description

number

Подписанные данные транзакции

signature

object

Подпись для Уровня 1. Для ChangePubKey должен быть null

fastProcessing

boolean

null

Нажмите здесь, чтобы узнать, как создать транзакцию.

PreviousВзаимодействие с ZKSwap NextСоздание транзакции

Last updated 3 years ago