Query Currency

API Overview

This API retrieves the list of supported currencies in the system, with options for pagination and keyword-based fuzzy search.

  • Request Method:GET

  • Request URL:https://openapi.elven.com/open/v3/currency

Request Headers

Parameter NameTypeRequiredDescription

elven-api-key

String

Yes

The API key assigned to you

elven-api-sign

String

Yes

Request signature, used to verify the legitimacy of the request

elven-api-timestamp

String

Yes

Request timestamp, in milliseconds

View Details

Request Parameters

Query 参数

Parameter NameTypeRequiredDescription

page

Number

No

The page number to retrieve. Defaults to 1 if not provided.

limit

Number

No

The number of records per page. Defaults to 10 if not provided.

keyword

String

No

A keyword for fuzzy search. If omitted, no filtering is applied.

Example Request

GET https://openapi.elven.com/open/v3/currency?page=1&limit=10&keyword=b

Response Parameters

Parameter NameTypeDescription

total

Number

The total number of currencies matching the query.

list

Array

A list of currencies

list of objects

Parameter NameTypeDescription

name

String

The name of the currency

currency

String

The currency code (e.g., BTC, USD).

type

String

The type of currency (CRYPTO for cryptocurrencies, FIAT for fiat currencies).

Example Response

{
    "total": 100,
    "list": [
        {
            "name": "Bitcoin",
            "currency": "BTC",
            "type": "CRYPTO"
        },
        {
            "name": "United States Dollar",
            "currency": "USD",
            "type": "FIAT"
        }
    ]
}

Notes

  • The following headers are required for all requests to ensure security and validity: elven-api-key,elven-api-sign,elven-api-timestamp

  • If page and limit are not provided, the API defaults to returning the first page with 10 records per page. If keyword is not provided, no keyword filtering is applied.

Last updated