API开通即用版本 1.0.190582466

汇率查询

查询参考汇率(不是交易价格),可取最新值或某一天的值。不同数据源支持的基准货币和更新频率不同,见下方数据源表。

不依赖你自己的任何账号,在组织中开通后即可调用。

商品介绍

查询参考汇率(不是交易价格),可取最新值或某一天的值。不同数据源支持的基准货币和更新频率不同,见下方数据源表。 ## 数据源 请求中的 `provider` 从以下数据源中选择: - `frankfurter` (eu) - `us-treasury` (us) ## 调用与计费 - 调用 ID(`invocation_id`)由市场网关写入,请求中无需携带,携带的值会被替换。 - 只有服务返回执行成功(`data.execution.outcome` 为 `succeeded`)的调用按一次请求计费;参数错误、数据源失败和结果未知的调用不计费。 - 服务在 `data.execution.usage.units` 中报告用量,单位为 `rates`。

价格

免费

  • 按请求:免费

按实际用量计费,开通本身不收费。调用成功后才计量。

以上为公开标价。你的组织可能有协议价,以控制台显示的价格为准。

档位

档位
zgiservices · standard
档位标识
zgi-exchange-rate-standard
接口协议
HTTP 接口

如何使用

  1. 为组织开通

    在控制台为组织开通此商品。开通后即可调用,不需要你自己的厂商账号。

  2. 创建凭证

    在控制台“凭证”中创建一个凭证。密钥只显示一次,请保存到环境变量 ZGI_MARKET_KEY,并在每次请求中携带:

    Authorization: Bearer $ZGI_MARKET_KEY

    也可以使用 X-API-Key 请求头。一份凭证可以调用组织已开通的所有商品。

  3. 调用网关

    沿用厂商原有的请求与响应格式,只需把 Base URL 和密钥换成下面的值。

    Base URL
    https://market-api.zgi.im/v1/gateway/zgi-exchange-rate-standard
    请求示例
    curl -X POST "https://market-api.zgi.im/v1/gateway/zgi-exchange-rate-standard/v1/exchange-rate-queries" \
      -H "Authorization: Bearer $ZGI_MARKET_KEY" \
      -H "Content-Type: application/json" \
      -d '{}'

    入参与输出

    各操作的入参和输出结构,以 JSON Schema 描述。

    POST /v1/exchange-rate-queries

    入参 Schema
    {
      "type": "object",
      "required": [
        "provider",
        "base",
        "quotes"
      ],
      "properties": {
        "base": {
          "type": "string",
          "description": "ISO 4217 base currency, for example USD or EUR."
        },
        "date": {
          "type": "string",
          "description": "Optional YYYY-MM-DD; omitted means the latest published rates."
        },
        "quotes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "1-20 ISO 4217 quote currencies."
        },
        "provider": {
          "enum": [
            "frankfurter",
            "us-treasury"
          ],
          "type": "string",
          "description": "Provider that serves the request; choose by the coverage described for this tool."
        }
      },
      "additionalProperties": false
    }
    输出 Schema
    {
      "type": "object",
      "required": [
        "code",
        "data"
      ],
      "properties": {
        "code": {
          "type": "integer"
        },
        "data": {
          "type": "object",
          "required": [
            "execution",
            "result"
          ],
          "properties": {
            "result": {
              "type": "object",
              "required": [
                "base",
                "rate_date",
                "requested_date",
                "rates",
                "unavailable_quotes",
                "source",
                "retrieved_at"
              ],
              "properties": {
                "base": {
                  "type": "string"
                },
                "rates": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "required": [
                      "quote",
                      "rate"
                    ],
                    "properties": {
                      "rate": {
                        "type": "number"
                      },
                      "quote": {
                        "type": "string"
                      }
                    }
                  }
                },
                "source": {
                  "type": "object",
                  "required": [
                    "name",
                    "kind"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                },
                "rate_date": {
                  "type": "string"
                },
                "retrieved_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "requested_date": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "unavailable_quotes": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "string"
                  }
                }
              }
            },
            "execution": {
              "type": "object",
              "description": "The recorded execution: id, invocation_id, outcome, usage, and timing."
            }
          }
        },
        "message": {
          "type": "string"
        }
      }
    }

来源与审核

审核状态
未记录
许可证
未说明

审核状态是平台对上架信息的记录,不构成对上游服务质量或可用性的担保。