API docs by Redocly

Hotel Resale API provided by Tabiyory (1.0.0)

Download OpenAPI specification:Download

Introduction

About this document

This document provides the interface specifications for the RESTful API offered by Tabiyory, enabling functionalities such as hotel search, rate inquiries, order placement, and order management. It serves as a reference for agents who have entered into a partnership agreement with our company to utilize the Tabiyory API effectively. This API is designed to streamline operations for agents by offering seamless integration into their systems, supporting efficient management of hotel-related data.

Environment

Before going live, we provide a verification environment for operation checks and integration testing with the agent's product. Once the agent's development is complete and both parties have confirmed that there are no issues in the verification environment, we will issue the necessary keys for the public API environment. The specific steps are as follows:

Process for Starting Service Usage

  1. Application for Service Usage
  2. Conclusion of API Connection Agreement
  3. Provision of Test API Key, Contract No, and Access Information
  4. Verification and Testing in the Test Environment Please access the verification environment endpoints labeled "Tabiyory API server on Develop Environment" for each API and proceed with the operation checks.
  5. Provision of Production API Key, Contract No, and Access Information
  6. Start Using the Public API

OverView of This APIs

Request Headers Configuration

All API requests require the following headers for authentication

Header Value
Contract-No This is a unique identifier provided by Tabiyory. It must be included in the request header for authentication.
Authorization This header must be calculated for each request using the following steps
Content-type application/json

Calculating the Authorization Header

  • Subscription_KEY: Provided by Tabiyory.
  • salt: Calculated using the current Unix timestamp in the following way
  • salt = unix_timestamp & 1000 (Ensure the last three digits are set to 000).
  • Authorization: The final Authorization header is generated by applying the sha512 algorithm (bcrypt/SHA512) to the string:
Authorization = sha512(subscription_key + salt)

Example in JavaScript

Here's how to compute the Authorization header in JavaScript

javascript
const salt = Math.floor(Math.floor(Date.now() / 1000) / 1000) * 1000;
const inputString = subscriptionKey + salt;
const crypto = require('crypto-js');
const Authorization = crypto.SHA512(inputString).toString(crypto.enc.Hex);

Response

  • All responses are returned in application/json format.
  • All responses are encoded with UTF-8.

HTTP STATUS we use are below.

CODE Detail Description
200 TabiyoryAPI Works well detail status is in "result" field of each response.
400 Bad Request no hotel, no room etc
403 Authentication Error API authentication error
500 Internal Server Error system error

you can also confirm Error reason if API returns data with more detail status in "result" field.

CODE Description
00 NoError OK
01 SubscriptionError Token not available
02 SubscriptionError No subscription feature at all
11 SubscriptionError Contract has expired
12 SubscriptionError Call rate limit is exceeded
20 External API Error External Vendor replies with some error
90 InvalidRequest [] is required
91 NotSupportedVendorError Vendor not supported
92 SystemError Internal Server Error
93 ExecuteError Unable to execute the flow for W"\" Connector. Unable to find value for reference (XPATH: ).*
99 UnknownError Detail if any

How to use these API

API List

Step Description Detail Remarks Update frequency
1 Retrieve Master Data Getting geometry, currency, language master data GET /masters/language
GET /masters/currency		 Rarely
2 Retrieve Hotel & Room Data Getting hotels list and information GET /hotel/contents/hotels
GET /hotel/contents/room		 EveryWeek
3 Retrieve Cached Data Date-specific pricing information GET /hotel/cache/roomsearch
GET /hotel/cache/search		 EveryDay
4 Checking the Latest Pricing Retrieves the latest availability & pricing based on selected plans and dates GET /hotel/avail/hotel
GET /hotel/avail/plan		 Each Reservation
5 Order Process Create, Confirm, Retrive, Cancel order POST /hotel/orders
GET /hotel/orders
GET /hotel/orders{order_ids}/
POST /hotel/orders/{order_ids}/confirm
GET /hotel/orders/{order_ids}/voucher
POST /hotel/orders/{order_ids}/cancel		 Each Reservation
6 Deposit Balance & History Check the current deposit balance and transaction history GET /common/balance
GET /common/balance/history		 As Needed

Purchase Flow

Flow Chart

graph TD; A[Retrieve Data
master, contents, rate cache] -- with desired quantity , date and property --> B{"Call Tabirory RealTime API
get latest plan and price "}; B -- OK --> C{"Check Balance
before ordering, please confirm enough amount"}; C -- OK --> D{"Call order API
start-booking"}; C -- short and charge --> C; D -- OK --> E{"Call confirm API
finalize-booking"}; E -- OK --> F{"Take a capture
for user's credit card"}; F -- OK --> DONE["Success
Call get-booking-details for voucher"]; B -- NG --> END_F1[retry with other condition]; D -- NG --> END_F1[retry with other condition]; E -- Error --> END_CONTACT["Contact Tabiyory"];

About Pricing

About the Rate Types We Provide

  • All responses are returned in the format of "Room Rate" + "Additional Details".
  • If the property offers a per-person, per-night rate type, our API will return response including the field [extra_person_fee] in the rate details.
  • For a per-room, per-night rate type, this field will not be included.

For further details, please refer to the descriptions of each API field.

Steps to book

1. Data Acquisition

Since the API provides all the information necessary for product searches, we strongly recommend that agents build their own product databases. To save products to the database, you need to call the following APIs

  • GET /masters: Retrieves the master data such as country, area, currency.
  • GET /hotel/contents: Retrieves hotel content information (hotel lists, room details).
  • GET /hotel/cache: Retrieves cached rate information for hotels.

Regarding content, hotel lists or room information will be returned as response data, and all product information can be obtained by paging. Regular updates to the content cached in the database are recommended to ensure that the latest information can be provided to end users.

You can obtain property_id, city_code, etc., from the /contents and /master endpoint, which will be required for product searches and making an order.

2. Checking Price Data

You can check rate plans for rooms by using the following cache data endpoints

  • GET /hotel/cache/roomsearch: Retrieves cached room search data of each property_id.
  • GET /hotel/cache/search: Retrieves cached search data of hotels in some area.

When creating an order, always check the availability of the room and rate type. If you have the room_product_key, room_product_code, and vendor_code, you can directly check the latest status of the cache data.

3. Check Availability

When placing an order, be sure to check availability to get the latest information When you call this APL, you need to set the condition including check-in/check-out date, property_id and number of guest.

  • GET /hotel/avail/plan: Check room-plan availability.
  • GET /hotel/avail/hotel: Check hotel availability.

Keep the avail_uniq_id and room_id returned in the response, as these will be required when placing an order.

4. Create an Order

Once you have confirmed availability, you can create an order using

  • POST /hotel/order: Create an order for a hotel room.

Before placing an order, use GET /balance to ensure sufficient balance.

If you wish to get the balance history, use GET /balance/history. Keep the order_uid returned when the order is created. This will be required for confirming or checking the status of the order.

5. Confirm Reservation

After placing an order, you can confirm it using the following methods

  • GET /hotel/orders: Retrieve all orders.
  • GET /hotel/orders/{order_uid}: Retrieve specific order details.
  • POST /hotel/order/confirm: Confirm the reservation.

To get a voucher for the confirmed order, use

  • GET /hotel/order/voucher: Retrieve the voucher for the confirmed order.

To cancel an order, use

  • POST /hotel/orders/{order_uid}/cancel: Cancel the order.

6. Status of order

STATUS Description Remarks
Provisional Order At this stage, the order is not yet confirmed. Please note that some products may be "Instantly Confirmed Orders."
Cancellation Before Confirmation If the order is not confirmed by the deadline or is manually canceled before confirmation no cancellation charges will apply.
Confirmation Once confirmed, the cancellation policy will be enforced for any cancellations. After confirmation, we issue the Invoice and Voucher.
Cancellation After Confirmation Once confirmed, the cancellation policy will be enforced for any cancellations. A cancellation fee may apply based on the cancellation policy.
Regarding Changes Changes cannot be made. Please cancel and rebook if necessary.
Cancellation Due to Operator Circumstances The operator may cancel the order due to their own reasons, resulting in a contract cancellation. This is our disclaimer.

Attension

  • The rate cache information provided by H-3001/H-3002 is for reference only and may differ from the latest rates and availability.
  • we can't accept change the order. so if you need them, please cancel the order and re-book via aval and order API.
  • before order and cancellation, please confirm cancel policy.

master

get generic information like countries, areas, currencies. before access to our various API, need to get all these data.

M-1001 Retrieve all country data that we support.

Retrieve a list of all countries that we support. This API provides country codes, names, region codes, and other details relevant for other API calls.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "countries": [
    ]
}

M-1002 Retrieve all area data that we support.

Retrieve a list of all areas within a specified region, country, and optionally a specific prefecture. This API provides detailed geographical hierarchy, including regions, prefectures, cities, and sub-areas.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
region_code
required
string
Example: region_code=VA_1

region code of the target area.
country_code
required
string
Example: country_code=JP

country code of the target area.
prefecture_code
string
Example: prefecture_code=VST_01

State or Prefecture code of the target area.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "regions": [
    ]
}

M-1003 Retrieve all currency data that we support.

Retrieve a list of all currencies supported by the API. This includes the currency code and the currency name that can be used in other API requests.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "currencies": [
    ]
}

M-1004 Retrieve all language data that we support

Retrieve a list of all supported languages, including the language code, name, and a description in the specified language.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "languages": [
    ]
}

contents

get hotel's static information. It shoule get these data periodically to update hotel database.

H-2001 Retrieve all hotel content data that we supports.

Retrieve detailed information about hotels, including their categories, rankings, location, facilities, rooms, issues, media, and nearby points of interest. This data can be filtered by country, prefecture, and hotel-specific attributes.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
size
number
Default: 20
Example: size=20

Number of items returned per page
page
number
Default: 1
Example: page=1

Current page offset.
country_code
required
string
Example: country_code=JP

Country code of the target hotel (e.g., "JP" for Japan). Refer to the list of supported country codes.
prefecture_code
string
Example: prefecture_code=VST_01

State/Prefecture code of the target hotel. This is optional. If not provided, hotels from all prefectures are returned.
property_ids
string
Example: property_ids=1,2,3

List of hotel IDs to filter results. If not provided, all hotels are returned.
fields
string
Example: fields=facility,media,room

Specify attributes to filter by (e.g., "facility", "media", "room"). Use "all" to return all attributes.
last_update_time
string <date>
Example: last_update_time=2020-03-03

The last update date in the format YYYY-MM-DD. This helps filter hotels updated since a particular date.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "hotels": [
    ],
  • "pagination": {
    }
}

H-2002-Retrieve all room information that supports in aggregation

This API retrieves detailed information about the rooms associated with a specific hotel. It includes information such as room types, descriptions, maximum and minimum occupancy, amenities, and special notes. The API supports pagination and allows filtering results by language and hotel ID. Use this endpoint to fetch room data for integration into hotel booking or management systems.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
size
number
Default: 20
Example: size=20

Number of items returned per page
page
number
Default: 1
Example: page=1

Current page offset.
property_id
required
string
Example: property_id=824510

Unique identifier for the hotel.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "property_id": "824510",
  • "rooms": [
    ],
  • "pagination": {
    }
}

cache

get reference price information of each hotel. It's cache data we collect. This cached information helps you to understand pricing information and compare hotels.

H-3001 Search price information of the hotel rooms from Cache DB

This API searches cached price information for hotel rooms based on provided conditions, including room configuration, check-in date, and number of nights. It retrieves detailed information such as cancel policies, vendor responses, room details, and pricing.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
currency_code
required
string
Enum: "JPY" "USD" "KRW" "CNY" "EUR"
Example: currency_code=JPY

set currency code to use in API calls
property_id
required
string
Example: property_id=824510

Hotel ID
rooms
required
string
Example: rooms=1-0-;1-1-2;2-2-5,8

Room configuration in the format adult-child-childages.
check_in
required
string <date>
Example: check_in=2024-11-25

Check-in date (YYYY-MM-DD).
nights
required
integer
Example: nights=1

Number of nights to stay.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "check_in": "2024-11-25",
  • "nights": 1,
  • "hotels": [
    ]
}

H-3002-Check Rate of Hotels

This API retrieves the lowest available rates for hotels based on location (city or subarea), room configurations, check-in date, and number of nights. It supports pagination and provides detailed pricing information, including NET and GROSS values.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
currency_code
required
string
Enum: "JPY" "USD" "KRW" "CNY" "EUR"
Example: currency_code=JPY

set currency code to use in API calls
city_code
string
Example: city_code=VCT_TKYO

Location code (city code) of the target area.
subarea_code
string
Example: subarea_code=VSAT_TKYO01

Subarea code (specific area within a city).
rooms
required
string
Example: rooms=1-0-;1-1-2;2-2-5,8

Room configurations in the format adult-child-childages.
check_in
required
string <date>
Example: check_in=2020-03-03

Check-in date (YYYY-MM-DD).
nights
required
integer
Example: nights=1

Number of nights to stay.
size
number
Default: 20
Example: size=20

Number of items returned per page
page
number
Default: 1
Example: page=1

Current page offset.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "check_in": "2020-03-03",
  • "nights": 1,
  • "hotels": [
    ],
  • "pagination": {
    }
}

avail

get lastest and realtime price and availavility information from Supliers we support.

H-4001 Search realtime availability and price of the hotel-plan

This API checks the realtime availability of the specific hotel-plan based on specified conditions, including check-in date, room configurations, and number of nights. It provides details about pricing, cancellation policies, and other vendor-specific information.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
currency_code
required
string
Enum: "JPY" "USD" "KRW" "CNY" "EUR"
Example: currency_code=JPY

set currency code to use in API calls
property_id
required
string
Example: property_id=824510

Hotel ID
rooms
required
string
Example: rooms=1-0-;1-1-2;2-2-5,8

Room configurations in the format "adult-child-childages;".
check_in
required
string <date>
Example: check_in=2020-03-03

Check-in date (YYYY-MM-DD).
nights
required
integer
Example: nights=1

Number of nights to stay.
only_avail
required
string
Example: only_avail=1

Availability filter

  • 0: all
  • 1: available only
no_finalbook
string
Example: no_finalbook=1

Indicate if the search is not for final booking purposes.

  • 0: not final
  • 1: finalbook
extra_param
string
Example: extra_param=field_name-value,fieldname-value

Additional parameters in the format [field_name-value,fieldname-value,...].

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "avail_uniq_id": "42",
  • "hotels": [
    ]
}

H-4002 Search realtime availability and price of the hotel which we support

This API checks the realtime availability of the specific hotel based on specified conditions, including check-in date, room configurations, and number of nights. It provides details about pricing, cancellation policies, and other vendor-specific information.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
currency_code
required
string
Enum: "JPY" "USD" "KRW" "CNY" "EUR"
Example: currency_code=JPY

set currency code to use in API calls
property_id
required
string
Example: property_id=824510

Hotel ID
rooms
required
string
Example: rooms=1-0-;1-1-2;2-2-5,8

Room configurations in the format "adult-child-childages;".
check_in
required
string <date>
Example: check_in=2020-03-03

Check-in date (YYYY-MM-DD).
nights
required
integer
Example: nights=1

Number of nights to stay.
only_avail
required
string
Example: only_avail=1

Availability filter e.g., 0=all, 1=available only
no_finalbook
string
Example: no_finalbook=1

Indicate if the search is not for final booking purposes.1=finalboon,0=not final
extra_param
string
Example: extra_param=field_name-value,fieldname-value

Additional parameters in the format [field_name-value,fieldname-value,...].

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "avail_uniq_id": "42",
  • "hotels": [
    ]
}

order

make, confirm and cancel order via our API.

H-5001 Submit a hotel order for booking

This API allows submitting a hotel order for booking using the provided availability ID. It validates guest information, room details, and other booking parameters.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object (common)
avail_uniq_id
string

Availability unique ID obtained from the availability API.
object

Information about the booking holder.
vendor_reference
string <= 50 characters

Vendor reference for the booking.
object

Hotel information for the booking.
checkin
string <date>

Check-in date (YYYY-MM-DD).
checkout
string <date>

Check-out date (YYYY-MM-DD).
nights
integer [ 1 .. 10 ]

Number of nights to stay.
Array of objects

List of rooms to book.
Array of objects

Additional parameters for the booking.

Responses

Request samples

Content type
application/json
{
  • "common": {
    },
  • "avail_uniq_id": "27",
  • "holder": {
    },
  • "vendor_reference": "APWA#04352",
  • "hotel": {
    },
  • "checkin": "2024-09-06",
  • "checkout": "2024-09-07",
  • "nights": 1,
  • "rooms": [
    ],
  • "extra_param": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "ordering": {
    }
}

H-5003 Retrieve detailed data of a hotel order

This API retrieves detailed information about a specific hotel order, including its status, pricing, holder details, and associated hotel and room data.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
order_uid
required
string
Example: order_uid=10

Unique ID of the order to retrieve.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "order_uid": "10",
  • "itinerary_info": "1",
  • "vendor_reference": "APWA#04352",
  • "ordering": {
    }
}

H-5002 Retrieve a hotel order

This API retrieves a list of hotel orders based on various filtering parameters such as date range, hotel ID, destination, and order status. The response includes order details and associated metadata.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
size
number
Default: 20
Example: size=20

Number of items returned per page
page
number
Default: 1
Example: page=1

Current page offset.
order_status
string
Example: order_status=ALL

Filter the order list by status:

  • 0: ALL
  • 1: RQ
  • 2: OK
  • 3: CFM
  • 4: CXL
  • 5: UC
country_code
string
Example: country_code=country1,country2

Filter the order list by hotel country code. Multiple values can be separated by commas.
prefecture_code
string
Example: prefecture_code=destination1,destination2

Filter the order list by hotel destination code. Multiple values can be separated by commas.
property_id
string
Example: property_id=hotel1,hotel2

Filter the order list by hotel property ID. Multiple values can be separated by commas.

start
required
string <date>
Example: start=2020-03-03

Start date for the booking range (YYYY-MM-DD).
end
required
string <date>
Example: end=2020-03-10

End date for the booking range (YYYY-MM-DD).

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "orderings": [
    ],
  • "pagination": {
    }
}

H-5004-Submit a confirm data of a hotel order

This API is used to confirm a hotel order, including payment information and final status updates.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object (common)
order_uid
string

Unique ID of the order to confirm.
object

Payment information associated with the order.

Responses

Request samples

Content type
application/json
{
  • "common": {
    },
  • "order_uid": "20",
  • "payment": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "order_uid": "12",
  • "vendor_reference": "APWA#04352",
  • "final": {
    },
  • "offset_date": {
    },
  • "charges": [
    ]
}

H-5005 Retrieve a voucher information of a hotel order

This API retrieves PDF Voucher about a specific hotel order.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
type
required
string
Example: type=Voucher

Type of Voucher
order_uid
required
string
Example: order_uid=10

Unique ID of the order to retrieve.

Responses

Response samples

Content type
application/json
{}

H-5006-Submit to cancel a hotel order

This API handles cancellation of hotel orders. Depending on the cancellation_flag, it can either confirm cancellation details or perform the cancellation.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object (common)
order_uid
string

Unique ID of the order to be canceled.
cancellation_flag
string

Specifies the action to perform:

  • 1: "CANCELLATION" (Perform cancellation)
  • 0: "CONFIRMATION" (Only confirm cancellation details)

Responses

Request samples

Content type
application/json
{
  • "common": {
    },
  • "order_uid": "12",
  • "cancellation_flag": "1"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "cancel": {
    }
}

common

get common information like balance data

C-6001 Retrieve current balance information

This API retrieves balance amount of the agent. Before making order, please confirm it is enough amount for making the order.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "balances": [
    ]
}

C-6002 Retrieve all history balance information

This API retrieves detailed information about balance history, including its status, pricing, date etc.

Authorizations:
ApiKeyAuth
query Parameters
language_code
required
string
Enum: "ja-JP" "zh-CHS" "zh-CHT" "zh-CN" "zh-HK" "zh-MO" "zh-SG" "zh-TW"
Example: language_code=ja-JP

set locale code. need ISO639 and ISO3166-1
size
number
Default: 20
Example: size=20

Number of items returned per page
page
number
Default: 1
Example: page=1

Current page offset.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "transactions": [
    ],
  • "pagination": {
    }
}