Skip to content
Longport WhaleLongport Whale
Currency Setup

Currency Setup

Queries Currency Setup data. Combine business filters in filters, and use page and page_size to control pagination.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_currency_configs

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
currency_isostring

Filters results by Currency code.

Allowed values: USD, HKD, SGD, CNY, AUD, JPY, GBP, EUR, CAD, MYR, AMD, BGN, BTN, BWP, BZD, CDF, CHF, DKK, GHS, GMD, GNF, HRK, HUF, ILS, INR, IQD, IRR, ISK, LRD, LYD, MOP, RUB, UAH, UGX, UYI, UYU, UZS, XAF, XOF, XSU, YER, IDR, TWD, THB, KRW, NZD

USD · USDHKD · HKDSGD · SGDCNY · CNYAUD · AUDJPY · JPYGBP · GBPEUR · EURCAD · CADMYR · MYRAMD · AMDBGN · BGNBTN · BTNBWP · BWPBZD · BZDCDF · CDFCHF · CHFDKK · DKKGHS · GHSGMD · GMDGNF · GNFHRK · HRKHUF · HUFILS · ILSINR · INRIQD · IQDIRR · IRRISK · ISKLRD · LRDLYD · LYDMOP · MOPRUB · RUBUAH · UAHUGX · UGXUYI · UYIUYU · UYUUZS · UZSXAF · XAFXOF · XOFXSU · XSUYER · YERIDR · IDRTWD · TWDTHB · THBKRW · KRWNZD · NZD

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Currency Setup records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
idstring

Returned value: Unique identifier of the current record.

account_channelstring

Returned value: Account Channel.

currency_isostring

Returned value: Currency code.

standard_moneystring

Returned value: Standard Currency.

abbrev_name_cnstring

Returned value: Abbreviation In Simplified Chinese.

abbrev_name_hkstring

Returned value: Abbreviation In Traditional Chinese.

name_cnstring

Returned value: Full Name In Simplified Chinese.

name_hkstring

Returned value: Full Name In Traditional Chinese.

currencystring

Returned value: Displayed Currency.

iconstring

Returned value: Icon.

min_exchange_amountstring

Returned value: Minimum Exchange Amount.

min_withdrawal_amountstring

Returned value: Minimum Withdrawal Amount.

min_cash_amountstring

Returned value: Cash Amount.

app_showstring

Returned value: Asset Display.

support_withdrawstring

Returned value: Withdrawal Function.

support_depositstring

Returned value: Deposit Feature.

support_exchangestring

Returned value: Exchange Feature.

exchange_rate_precisionstring

Returned value: Exchange Rate Precision.

amount_precisionstring

Returned value: Amount Precision.

amount_round_modestring

Returned value: Retrieval Logic.

amount_round_mode_valstring

Raw value of amount_round_mode. The amount_round_mode field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Returned value: Created Time. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Update Time. The date or time format follows the value returned by the API.

remarksstring

Returned value: Remark.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs