すべてのドキュメントを閲覧

パーム油現物系列API

商品と国から受け入れ済みの パーム油 現物価格系列を検索

エンドポイントとリクエスト

REST エンドポイント
GET /v1/commodities/palmoil/physical
契約リクエスト
curl --request GET \
  --url "https://api.narwhalapi.com/v1/commodities/palmoil/physical?product=ffb&country=IDN&area=ID-RI&limit=100" \
  --header "Authorization: Bearer $NARWHAL_API_KEY"

MCPの使用 commodities_list_palmoil_physical_seriesです。REST と MCP は、スキーマ、アカウントのクォータ、権限チェック、エラー形式を共有します。

パラメータ

名前必須種別意味
productいいえクエリ · ffbまたはcpo現物商品で絞り込みます。
countryいいえクエリ · ISO 3166-1 alpha-3IDNなどの国コードで絞り込みます。
areaいいえクエリ · 地域ID検索APIが返す地域IDを使用します。該当する場合はISO 3166-2、それ以外はnwl-mys-northなどNarwhal定義のnwl-* IDです。
price_typeいいえクエリ · 列挙型official_purchase_schedule、government_reference、market_averageのいずれか。商品に対応する値を指定してください。
currencyいいえクエリ · 通貨コードIDR、USD、MYRなど元の通貨で絞り込みます。価格の通貨換算は行いません。
producer_typeいいえクエリ · 小規模農家インドネシアのFFB買取価格表に適用されます。product=cpoとの併用はできません。
producer_arrangementいいえクエリ · 列挙型purchase_agreementまたはsupported_scheme。インドネシアのFFB価格表に適用され、product=cpoとの併用はできません。
limitいいえクエリ · 整数、1~5001ページ当たりの最大系列数。既定は100件です。
cursorいいえクエリ · 不透明な文字列返されたnext_cursorを使い、元の全フィルターとlimitを変更せずに次のページを取得します。

レスポンス

契約例
{
  "series": [
    {
      "series_id": "id-ri-oil-palm-ffb-smallholder-purchase-agreement",
      "product": "ffb",
      "observation_type": "age_schedule",
      "period_type": "effective",
      "country": "IDN",
      "area": "ID-RI",
      "producer_arrangement": "purchase_agreement",
      "price_type": "official_purchase_schedule",
      "currency": "IDR",
      "unit": "kilogram",
      "coverage_start": "2026-08-19",
      "coverage_end": "2026-09-01",
      "frequency": "weekly"
    }
  ],
  "next_cursor": null
}
フィールド種別必須意味
series配列はい安定したseries_id順に並べた、承認済み系列の完全版。
series[].series_id文字列はい履歴操作で使用する安定した識別情報。
series[].product / series[].country文字列はい商品と地理的範囲。
series[].area文字列いいえ全国系列ではareaを省略します。地域IDにはnwl-*名前空間を使用する場合があります。
series[].observation_type / series[].period_type列挙型はいscalarまたはage_schedule、effectiveまたはobservation。レスポンス形式と日付の意味を定義します。
series[].price_type / series[].currency / series[].unit文字列はいソースが定義する価格種別、通貨、元の単位。
series[].producer_arrangement文字列いいえインドネシアFFBの樹齢別価格表の系列で、情報源が取り決めを明示している場合にのみ含まれます。それ以外は省略されます。
series[].frequency / series[].coverage_start / series[].coverage_end文字列と日付はい更新頻度と受入済み履歴の期間です。その期間に欠落がないことを保証するものではありません。
next_cursor文字列または nullはい次のページを取得するためのトークン。続きの系列がなければnullです。

エラーとクォータ

  • 400 invalid_query — コード、地域、日付範囲、上限、セレクターが無効です。
  • 400 invalid_cursor — カーソルが無効、または系列と範囲に一致しません。
  • 401 invalid_api_key — Bearer キーがないか拒否されました。
  • 409 cursor_expired, 公開データが変更されました。カーソルを指定せずにページ取得をやり直してください。
  • 429 rate_limit_exceeded または quota_exhausted — 共有枠を使い切りました。
  • 503 palmoil_unavailable — 完全な公開データでインターフェースを安全に満たせません。

拒否されたリクエストとサーバーエラーは月間クォータを消費しません。

カバレッジ

検索APIは、受入済みのインドネシアとマレーシアのCPO・FFB系列を一覧で返します。フィルターは商品、地域、価格種別、元の単位の違いを保持します。

Narwhal APIキーで利用できます。