Introduction

Welcome to the Zarpay24 API documentation. To get started with using our APIs, please follow these steps:

Register on Zarpay24
Complete your KYC; To ensure the security and compliance of our platform, you are required to complete the KYC (Know Your Customer) process. This involves verifying your identity. You will receive guidance through the process on our website.
Add a Payment Card; Once your account is registered and your KYC process is complete, you will need to add a payment card to your account. This will enable you to interact with the API for making transactions and other operations.

Authentication

You will be issued a unique API key that allows you to access and authenticate your requests to the Zarpay API. This key is crucial for securing your API calls

ZarPay24 expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: your_api_key_here

You must replace your_api_key_here with your personal API key.

To get your_api_key_here, contact Zarpay Support or send mail to tech@zarpay24.com.

Balance

Get Balance

curl --location --request GET 'https://napi.zarpay24.com/api/v1/assets/fiat-balance/' \
--header 'Authorization: your_api_key_here' \
--header 'Content-Type: application/json'

The above command returns JSON structured like this:

[
    {
        "symbol": "IRT",
        "balance": "20109",
        "blocked": "12"
    },
    {
        "symbol": "GOLD",
        "balance": "2017.317",
        "blocked": "0"
    }
]

This endpoint retrieves your balance of each coin.

HTTP Request

GET https://napi.zarpay24.com/api/v1/assets/fiat-balance/

Market

Get Coin Price

curl --location --request GET 'https://napi.zarpay24.com/api/v1/market/coins/GOLD/' \
--header 'Authorization: your_api_key_here' \
--header 'Content-Type: application/json'

The above command returns JSON structured like this:

{
    "id": 1,
    "symbol": "GOLD",
    "persian_name": "طلا آب‌شده",
    "buy_active": true,
    "sell_active": true,
    "max_order_qty": "350000000",
    "buy_price": "4000000",
    "sell_price": "3000000",
    "fee_percentage": "1.00",
    "unit": "گرم",
    "decimal_places": 4
}

This endpoint retrieves detailed information about a specific coin.

HTTP Request

GET https://napi.zarpay24.com/api/v1/market/coins/<symbol>/

URL Parameters

Parameter	Description
symbol	The symbol of coin to retrieve.

Buy Coin with Quantity

curl --location 'https://napi.zarpay24.com/api/v1/market/buy/' \
--header 'Authorization: your_api_key_here' \
--header 'Content-Type: application/json' \
--data '{
    "coin_id":1,
    "quantity":"12.00"
}'

The above command returns JSON structured like this:

{
    "id": 291,
    "coin": 1,
    "quantity": "2.0000",
    "quote": "8000000",
    "quote_with_fee": "8080000",
    "fee": 80000.0,
    "coin_price": "1000.00",
    "side": "buy",
    "state": "done",
    "request_type": 2,
    "source": "front",
    "user_tracker": null,
    "created_at": "2025-01-03T12:46:18.321695Z",
    "finalized_at": "2025-01-03T12:46:18.319125Z",
    "coin_name": "طلا آب‌شده"
}

This endpoint allows you to purchase a coin by specifying the desired quantity.

HTTP Request

GET https://napi.zarpay24.com/api/v1/market/buy/

Request Body

Parameter	Description
coin_id	The id of coin to buy.
quantity	The quantity of coin to buy.

Sell Coin with Quantity

curl --location 'https://napi.zarpay24.com/api/v1/market/sell/' \
--header 'Authorization: your_api_key_here' \
--header 'Content-Type: application/json' \
--data '{
    "coin_id":1,
    "quantity":"12.00"
}'

The above command returns JSON structured like this:

{
    "id": 291,
    "coin": 1,
    "quantity": "2.0000",
    "quote": "8000000",
    "quote_with_fee": "8080000",
    "fee": 80000.0,
    "coin_price": "1000.00",
    "side": "sell",
    "state": "done",
    "request_type": 2,
    "source": "front",
    "user_tracker": null,
    "created_at": "2025-01-03T12:46:18.321695Z",
    "finalized_at": "2025-01-03T12:46:18.319125Z",
    "coin_name": "طلا آب‌شده"
}

This endpoint allows you to sell a coin by specifying the desired quantity.

HTTP Request

GET https://napi.zarpay24.com/api/v1/market/sell/

Request Body

Parameter	Description
coin_id	The id of coin to sell.
quantity	The quantity of coin to sell.

Buy Coin with Quote

curl --location 'https://napi.zarpay24.com/api/v1/market/buy/' \
--header 'Authorization: your_api_key_here' \
--header 'Content-Type: application/json' \
--data '{
    "coin_id":1,
    "quote":"50000"
}'

The above command returns JSON structured like this:

{
    "id": 291,
    "coin": 1,
    "quantity": "2.0000",
    "quote": "8000000",
    "quote_with_fee": "8080000",
    "fee": 80000.0,
    "coin_price": "1000.00",
    "side": "buy",
    "state": "done",
    "request_type": 2,
    "source": "front",
    "user_tracker": null,
    "created_at": "2025-01-03T12:46:18.321695Z",
    "finalized_at": "2025-01-03T12:46:18.319125Z",
    "coin_name": "طلا آب‌شده"
}

This endpoint creates an order to buy a coin by specifying the desired quote amount.

HTTP Request

GET https://napi.zarpay24.com/api/v1/market/buy/

Request Body

Parameter	Description
coin_id	The id of coin to buy.
quote	Amount of quote currency to spend.

Sell Coin with Quote

curl --location 'https://napi.zarpay24.com/api/v1/market/sell/' \
--header 'Authorization: your_api_key_here' \
--header 'Content-Type: application/json' \
--data '{
    "coin_id":1,
    "quote":"50000"
}'

The above command returns JSON structured like this:

{
    "id": 291,
    "coin": 1,
    "quantity": "2.0000",
    "quote": "8000000",
    "quote_with_fee": "8080000",
    "fee": 80000.0,
    "coin_price": "1000.00",
    "side": "sell",
    "state": "done",
    "request_type": 2,
    "source": "front",
    "user_tracker": null,
    "created_at": "2025-01-03T12:46:18.321695Z",
    "finalized_at": "2025-01-03T12:46:18.319125Z",
    "coin_name": "طلا آب‌شده"
}

This endpoint creates an order to sell a coin by specifying the desired quote amount.

HTTP Request

GET https://napi.zarpay24.com/api/v1/market/sell/

Request Body

Parameter	Description
coin_id	The id of coin to sell.
quote	Amount of quote currency to receive.

Get Orders

curl --location 'https://napi.zarpay24.com/api/v1/market/orders/' \
--header 'Authorization: your_api_key_here' \
--header 'Content-Type: application/json'

The above command returns JSON structured like this:

{
    "page": 1,
    "page_size": "10",
    "total_pages": 1,
    "total_items": 1,
    "data": [
        {
            "id": 1,
            "coin": 2,
            "quantity": "1.0000",
            "quote": "470358",
            "quote_with_fee": "4662264",
            "fee": 47094.0,
            "coin_price": "4708.00",
            "side": "sell",
            "state": "done",
            "request_type": 2,
            "source": "front",
            "created_at": "2024-10-30T10:55:52.949253Z",
            "finalized_at": "2024-10-30T10:55:52.948687Z",
            "coin_name": "طلا آبشده"
        }
    ]
}

This endpoint retrieves a list of orders with pagination.

HTTP Request

GET https://napi.zarpay24.com/api/v1/market/orders/

Query Parameters

Parameter	Description
page	The page number to retrieve (default: 1).
page_size	The number of items per page (default: 10).

Get Order by User Tracker

curl --location 'https://napi.zarpay24.com/api/v1/market/orders/by-tracker/<user_tracker>/' \
--header 'Authorization: your_api_key_here' \
--header 'Content-Type: application/json'

The above command returns JSON structured like this:

{
    "page": 1,
    "page_size": "10",
    "total_pages": 1,
    "total_items": 1,
    "data": [
        {
            "id": 1,
            "coin": 2,
            "quantity": "1.0000",
            "quote": "470358",
            "quote_with_fee": "4662264",
            "fee": 47094.0,
            "coin_price": "4708.00",
            "side": "sell",
            "state": "done",
            "request_type": 2,
            "source": "front",
            "created_at": "2024-10-30T10:55:52.949253Z",
            "finalized_at": "2024-10-30T10:55:52.948687Z",
            "coin_name": "طلا آبشده"
        }
    ]
}

This endpoint retrieves the details of a specific order using the user_tracker identifier.

HTTP Request

GET https://napi.zarpay24.com/api/v1/market/orders/by-tracker/<user_tracker>/

URL Parameters

Parameter	Description
user_tracker	Unique tracker ID of the order to fetch details for.

Errors

The ZarPay24 API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The IP you are requesting from is not valid.
404	Not Found -- The specified source could not be found.
405	Method Not Allowed -- You tried to access a source with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
429	Too Many Requests -- You're requesting too many kittens! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.