Get Mega Coupon Balance

API Description

This interface provides Mega Coupon balance information, allowing users to filter data based on time range and status. It provides key details such as Mega Coupon balance, status, and validity period, enabling efficient asset management. Additionally, this interface helps users determine whether the advanced identity verification is required for usage.

For more information on Mega Coupon, refer to https://coinw.zendesk.com/hc/en-us/articles/23111150445977-Introduction-to-Futures-Mega-Coupon

Note: Mega coupon balance data is available through via Resful and Websocket APIs. This page describes the RESTful API. For information on the Websocket API, please click here

Precautions

None

Authentication

This is a private interface and requires authentication. For details on using the RESTful API, refer to Introduction > Authentication & Code Snippet > Futures > RESTful Private Interface.

Request Method

GET

Endpoint

/v1/perpum/account/almightyGoldInfo

Frequency Limit

The frequency limit for this interface is 1 requests/2s per user ID and IP. In addition to this per-interface limit, a global rate limit is also enforced.

For detailed information on Global rate limits and API Rate Limiting Policy, please refer to the "Frequency Limit" section at click here

Request Parameters

Parameter	Mandatory	Type	Description
startTime	false	Long	Validity start time
endTime	false	Long	Validity deadline
type	true	Integer	Mega Coupon status: 0: Pending effective 1: Unused 2: Used 3: Expired 4: Issuance failed

Response Parameters

Parameter	Type	Description
id	Long	Mega coupon ID
assetsOut	Integer	Whether the transferred assets are invalid: 1: yes, 0: no
agRecordId	Integer	Issuing record ID
kyc	Integer	Whether the advanced KYC is required: 1: yes, 0: no
currentAmount	BigDecimal	Remaining amount
totalAmount	BigDecimal	Total amount of Mega Coupon
type	Integer	Status: 0: Pending, 1: Unused, 2: Used, 3: Expired, 4: Issuance failed
startTime	long	Timestamp of validity start
endTime	long	Timestamp of validity end
remark	String	Remark
createdDate	long	Timestamp of date created
updateDate	long	Timestamp of the last update
userId	Long	User ID

Request Example

The following Python code shows how to get the Mega Coupon balance information.

Note: For a complete code example, please refer to Introduction > Authentication & Code Snippet > Futures > RESTful Private Interface.

params = {
    # "startTime" : "1740467460000",
    # "endTime" : "1740467430000",
    "type" : 3,    
    }
api_url = "/v1/perpum/account/almightyGoldInfo"
method = "GET"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key).  # the function FuturesRestfulPrivate() is defined in section (Introduction > Authentication & Code Snippet > Futures > RESTful Private Interface)

Note: For a complete Java code example, please refer to Introduction > Authentication & Code Snippet > Futures > RESTful Private Interface.

Response Example

The following is an example response returned by the above Python request:

{'code': 0,
 'data': [{'agRecordId': 4004,
   'assetsOut': 0,
   'backAmount': 0,
   'backMark': 0,
   'createdDate': 1740555154000,
   'currentAmount': 5,
   'endTime': 1742918400000,
   'id': 800149683,
   'kyc': 0,
   'name': '万能金',
   'processStatus': 0,
   'remark': '产品测试 Aimen Malik',
   'startTime': 1740555125000,
   'totalAmount': 5,
   'transferExpire': 0,
   'type': 1,
   'updateDate': 1740555154000,
   'userId': 1162061}],
 'msg': ''}