介绍

验证

OilpriceAPI 使用 API 令牌来验证请求。您可以在OilpriceAPI 仪表板中查看和管理您的 API 令牌 （打开新窗口）。

使用您的 API 令牌发出的请求会计入您的帐户请求限制，因此请务必保密。

要发出经过身份验证的请求，您的 API 令牌应在请求的标头中传递 Authorization。例如在cURL中 （打开新窗口）请求可以像这样传递：

curl https://api.oilpriceapi.com/v1/prices/latest \
-H 'Authorization: Token YOUR_API_KEY' \
-H 'Content-Type: application/json'

错误

OilpriceAPI 使用传统的 HTTP 响应代码来指示 API 请求的成功或失败。

一般来说： 2xx 范围内的代码表示成功。 4xx 范围内的代码表示根据所提供的信息失败的错误（例如，省略了必需的参数、您的 API 令牌已过期等）。 5xx 范围内的代码表示 OilpriceAPI 服务器出现错误。

分页

除了latest返回分页价格列表之外的所有端点。每页限制为 100 个结果。

在每个请求的响应标头中，您将找到一些分页信息，其中包括可以检索的记录总数、上一页/下一页的链接以及每页限制。例如，请求的标头可能包括：

total: 100000,
per-page: 100,
link: <http://api.oilpriceapi.com/v1/prices?page=1000>; rel="last", <http://api.oilpriceapi.com/v1/prices?page=2>; rel="next"

在此示例中，有 100,000 个可能的数据点可供检索，每页返回 100 个。要检索所有结果，需要创建一个循环来迭代 1000 (100,000/100) 个页面，并page=n在每次迭代时传递一个参数。

参数

OilpriceAPI 包含许多参数，可以将这些参数包含在请求 URL 中以优化返回的数据。

按类型

(default: spot_price)

by_type 参数指定返回的价格类型。有两种可能的类型：

• 现货价格
• 每日平均价格

如何使用 by_type 参数的示例：

https://api.oilpriceapi.com/v1/prices/past_week/?by_type=daily_average_price​

上面的示例将返回过去 7 天内可用的每日平均价格。

更多指南：https://docs.oilpriceapi.com/guide/#by-type