# 功能描述

# 货币

获得极简汇率所支持的所有货币及国际编码,符号等信息。

Name required 描述 数据限制
category No 指定货币种类,目前支持法定货币、数字货币、贵金属、大宗商品等四类。 法定货币: currency 数字货币:crypto 贵金属:metal 大宗商品:commodity 全部币种:all
apiKey Yes 即您的API Key
sign Yes 货币符号
// 请求示例
https://api.xcurrency.com/rate/mid/coins
		? apiKey = {your_api_key}

// 返回结果示例
{
"success": true,
"info": [
	{
      "name": "Chinese Yuan",
      "symbol": "CNY",
			"category": "currency",
			"sign": "¥",
	},
	{
      "name": "Russian Rouble",
      "symbol": "RUB",
			"category": "currency",
			"sign": "₽"
	}
	...]
}

# 实时汇率

返回所有货币或一组特定货币的实时汇率数据。

Name required 描述 数据限制
symbols No 指给定货币代码 若要传入多个货币参数,货币间以","间隔开。例:"CNY,JPY,USD"
category No 指定货币种类,目前支持法定货币、数字货币、贵金属、大宗商品等四类。 该参数会覆盖symbols所指定的货币代码使其失效,默认返回全部币种。 法定货币: currency 数字货币: crypto 贵金属: metal 大宗商品: commodity 全部币种:all
quote No 指定计价货币,默认值为USD
apiKey Yes 即您的API Key
// API Request
https://api.xcurrency.com/rate/mid/latest
    ? apiKey = {your_api_key}
    & symbols = GBP,JPY,EUR
		& quote = USD

// 返回结果示例
{
	"success": true,
	"request": {
		"currency": ["GBP", "JPY", "EUR"],
		"quote": "USD",
		"category": ""
	},
	"timestamp": 1591784799,
	"rates": {
		"EUR": 1.1352662104,
		"GBP": 1.2732897219,
		"JPY": 0.0093141315
	}
}

# 实时汇率换算

货币汇率转换,可以从极简平台提供的任意一种或一组货币,以任意数量转换成另一种货币的汇率价格。

Name required 描述 数据限制
from Yes 所要转换的货币 若要传入多个货币参数,货币间以","间隔开。例:"CNY,JPY,USD"
to No 指定转换货币,默认值为USD。
amount No 转换的数额,默认为1。
apiKey Yes 即您的API Key
//API 请求示例
https://api.xcurrency.com/rate/mid/convert
		? apiKey = {your_api_key}
		& from = GBP,JPY,EUR
		& to = USD
		& amount = 1

//返回参数示例
{
	"success": true,
	"request": {
		"from": ["GBP", "JPY", "EUR"],
		"to": "USD",
		"amount": 1
	},
	"timestamp": 1591865496,
	"rates": {
		"EUR": 1.1375728539,
		"GBP": 1.2689321781,
		"JPY": 0.0093526234
	}
}

# 历史汇率

返回一个或一组特定货币在某一历史时间点的历史汇率数据。

Name required 描述 数据限制
symbols Yes 指给定货币代码 若要传入多个货币参数,货币间以","间隔开。例:"CNY,JPY,USD"
quote No 指定计价货币,默认值为USD
date No 历史的日期,默认日期为当前UTC时间的前一天。 格式为"YYYY-MM-DD",例如"2020-01-01"
apiKey Yes 即您的API Key
// 请求示例
https://api.xcurrency.com/rate/mid/historical
		? apiKey = {your_api_key}
		& symbols = JPY,CNY,BTC
		& quote = USD
		& date = 2020-01-01
// 返回结果示例
{
	"success": true,
	"request": {
		"symbols": ["JPY", "CNY", "BTC"],
		"quote": "USD",
		"date": "2020-01-01"
	},
	"timestamp": 1591871565,
	"rates": {
		"BTC": 7219.3871225777,
		"CNY": 0.1435957405,
		"JPY": 0.0091736271
	}
}

# 历史汇率序列

返回两个指定时间节点间的历史汇率数据列。

Name required 描述 数据限制
symbol Yes 指给定货币代码 不可传入多个货币
quote No 指定计价货币,默认值为USD
start Yes 历史时间段起始时间戳 精确到秒级,10位整数,例:1592384088
end Yes 历史时间段结束时间戳 精确到秒级,10位整数,例:1592384088
interval No 历史汇率时间间隔,默认为天(daily) 每天: daily 每时: hourly
apiKey Yes 即您的API Key
// 请求示例
https://api.xcurrency.com/rate/mid/series
	? apiKey= {your_api_key}
	& symbol = CNY
	& quote = USD
	& start = 1590390173
	& end = 1591597965
	& interval = hourly
// 返回结果示例
{
    "success": true,
    "request": {
        "symbol": "CNY",
        "quote": "USD",
				"start": 1590390173,
        "end": 1591597965,
        "interval": "hourly"
    },
    "series": [
        {
            "timestamp": 1590390000,
            "rate": 0.14007603020603446
        },
        {
            "timestamp": 1590393600,
            "rate": 0.1400577410627778
        },
				...
    ]
}

# 实时 k 线图

获取实时汇率 K 线图。

Name required 描述 数据限制
symbols Yes 指给定货币代码 若要传入多个货币参数,货币间以","间隔开。例:"CNY,JPY,USD"
quote No 指定计价货币,默认值为USD
interval No 历史汇率时间间隔,默认为天(daily) 每天: daily 每时: hourly
apiKey Yes
// 请求示例
https://api.xcurrency.com/rate/mid/klines/latest
	? apiKey = {your_api_key}
	& symbols = CNY,JPY
	& quote = USD
	& interval = hourly
// 返回结果示例
{
	"success": true,
	"request": {
		"symbols": ["CNY", "JPY"],
		"quote": "USD",
		"interval": "hourly"
	},
	"klines": {
		"CNY": {
			"open": 0.1411438834,
			"high": 0.1411438834,
			"low": 0.1410994847,
			"close": 0.14110164170000003,
			"openTimestamp": 1592382831,
			"highTimestamp": 1592382839,
			"lowTimestamp": 1592386140,
			"closeTimestamp": 1592386431
		},
		"JPY": {
			"open": 0.0093082084,
			"high": 0.009314875633333332,
			"low": 0.0093082084,
			"close": 0.009314515366666666,
			"openTimestamp": 1592382831,
			"highTimestamp": 1592386199,
			"lowTimestamp": 1592382840,
			"closeTimestamp": 1592386431
		}
	}
}

# 历史 k 线图

返回两个指定时间节点间的历史汇率 K 线图数据列。

Name 是否必须 描述 数据限制
symbol Yes 指给定货币代码 不可传入多个货币
quote No 指定计价货币,默认值为USD
start Yes 历史时间段起始时间戳 精确到秒级,10位整数,例:1592384088
end Yes 历史时间段结束时间戳 精确到秒级,10位整数,例:1592384088
interval No 历史汇率时间间隔,默认为天(daily) 每天: daily 每时: hourly
apiKey Yes
// 请求示例
https://api.xcurrency.com/rate/mid/klines/historical
	? apiKey = {your_api_key}
	& symbol = CNY
	& quote = USD
	& start = 1590390173
	& end = 1591597965
	& interval = hourly
// 返回结果示例
{
    "success": true,
    "request": {
        "symbol": "CNY",
        "quote": "USD",
        "start": 1590390173,
        "end": 1591597965,
        "interval": "hourly"
    },
    "Klines": [
        {
            "open": 0.1400313148,
            "high": 0.1400313148,
            "low": 0.1400313148,
            "close": 0.1400313148,
            "openTimestamp": 1590393600,
            "highTimestamp": 1590393654,
            "lowTimestamp": 1590393654,
            "closeTimestamp": 1590397200
        },
        {
            "open": 0.1400328957,
            "high": 0.1401054705,
            "low": 0.1400217425,
            "close": 0.1401054705,
            "openTimestamp": 1590397200,
            "highTimestamp": 1590397194,
            "lowTimestamp": 1590393954,
            "closeTimestamp": 1590400800
        },
        ...
    ]
}

# 点数

每个接口请求都会包含 API 调用限制,点数的设定就是用于计算每次接口请求详情。

功能列表会在返回的每 100 个数据点(向上舍入)超过 100 个数据点默认值的情况下花费额外的点数。我们的轻量级端点 coins 不包括在此限制内,并且始终计为 1 个点数。有关更多详细信息,请参见各个端点文档。

端口 花费
coins 每次请求成功花费1个点数。
latest 每请求成功100个货币对信息花费1个点数
convert 每请求成功100个货币对信息花费1个点数
historical 每请求成功100个货币对信息花费1个点数
series 每请求成功100个货币对信息花费1个点数
klines/latest 每请求成功100个货币对信息花费1个点数
klines/historical 每请求成功100个货币对信息花费1个点数

注意:点数消耗完将无法再访问接口,每月点数不累计到下个月,会在每月的套餐生效日的格林尼治时间 0 点刷新点数。