MoroccoAPIالتوثيق
مرجع الواجهة

اختر مورداً. حدّد المعاملات. جرّب الطلب.

دون مفتاح APIإجابات JSONCORS مفتوح

الرقم الاستدلالي الشهري للأثمان

GET/api/v2/prices/cpi

معلومة مهمة. الرقم الاستدلالي للأثمان عند الاستهلاك الصادر عن المندوبية السامية للتخطيط، شهرياً، أساس 100 = متوسط 2017: المستوى الوطني و18 مدينة، من يناير 2017 إلى آخر شهر منشور على data.gov.ma. أرقام استدلالية فقط، دون حساب نسب التضخم. أسماء المنتجات بالفرنسية كما نُشرت.

فهم السياق

مثال توضيحي: رقم استدلالي قدره 110 يعني أن سلة المنتجات نفسها تكلف 10% أكثر من متوسط 2017. لحساب التضخم السنوي، قارن شهراً بالشهر نفسه من السنة السابقة: 110 مقابل 105 يعطي (110 ÷ 105 − 1) × 100 ≈ 4,8%. الأرقام توضيحية.

المعاملات

07
stringاختياري · الاستعلام

رمز المدينة من /prices/cpi/cities، أو national. حدّد city أو product أو كليهما.

stringاختياري · الاستعلام

رمز المنتج من /prices/cpi/products، مثل GR (الرقم العام) أو 01 (المواد الغذائية).

stringاختياري · الاستعلام

مستوى المنتج: general أو division أو group أو class.

stringاختياري · الاستعلام

بداية الفترة، مشمولة. شهر بصيغة YYYY-MM.

النمط^[0-9]{4}-(0[1-9]|1[0-2])$
stringاختياري · الاستعلام

نهاية الفترة، مشمولة. شهر بصيغة YYYY-MM.

النمط^[0-9]{4}-(0[1-9]|1[0-2])$
integerاختياري · الاستعلام

عدد النتائج في الصفحة. 100 افتراضياً، و500 كحد أقصى.

الحد الأدنى: 1الحد الأقصى: 500القيمة الافتراضية: 100
integerاختياري · الاستعلام

عدد النتائج المطابقة المراد تجاوزها. يبدأ من 0.

الحد الأدنى: 0الحد الأقصى: 2147483647القيمة الافتراضية: 0
فهم الإجابة

data: النتائج المطلوبة، في كائن أو قائمة.

meta: مصادر البيانات ورخصتها وتواريخها. تعني null أن القيمة غير معروفة أو غير متاحة.

meta.pagination: القوائم: 100 نتيجة افتراضياً، و500 كحد أقصى. استخدم limit وoffset؛ تكون meta.pagination.next_offset بقيمة null في الصفحة الأخيرة.

مثال توضيحي: مع limit=10 وoffset=0 تتضمن الصفحة الأولى 10 نتائج على الأكثر. إذا كانت next_offset تساوي 10، اطلب التالية بـoffset=10 والمرشحات نفسها. توقف عندما تصبح next_offset بقيمة null.

API v2 هو المسار المرجعي. تبقى مسارات /api/v1 القديمة أسماء بديلة متوافقة مع السلوك المنشور حالياً، بما فيه تقسيم الصفحات؛ لم يُحدد موعد لحذفها.

حقول الإجابة 7

تشير [] إلى كل عنصر في القائمة. تعني null غير معروف أو غير متاح، ولا تعني صفراً. لغة الدليل لا تترجم قيم المصادر.

dataobject[]

النتيجة المطلوبة: كائن واحد أو قائمة.

data[].city_codestring

رمز المدينة، أو national للمغرب ككل.

data[].product_codestring

رمز المنتج لدى المندوبية السامية للتخطيط، كما في /prices/cpi/products.

data[].product_namestring

اسم المنتج كما نشرته المندوبية السامية للتخطيط، بالفرنسية.

data[].levelstring

مستوى المنتج: general (جميع المنتجات) ثم division ثم group ثم class، من الأشمل إلى الأدق.

القيم المقبولة: "general" "division" "group" "class"

data[].monthstring

شهر الرصد، بصيغة YYYY-MM.

data[].indexnumber

الرقم الاستدلالي للأثمان في الشهر، أساس 100 = متوسط 2017. ليس ثمناً ولا نسبة تضخم.

بنية البيانات
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "city_code",
          "product_code",
          "product_name",
          "level",
          "month",
          "index"
        ],
        "properties": {
          "city_code": {
            "type": "string",
            "description": "MoroccoAPI city code; national is the index for Morocco as a whole."
          },
          "product_code": {
            "type": "string",
            "description": "HCP product code: GR for the general index, then 2, 3 or 4 digits."
          },
          "product_name": {
            "type": "string",
            "description": "Product label as published by HCP, in French, including its spelling and capitalisation."
          },
          "level": {
            "enum": [
              "general",
              "division",
              "group",
              "class"
            ],
            "description": "general (all products), division (2-digit code), group (3 digits) or class (4 digits)."
          },
          "month": {
            "type": "string",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
            "description": "Month of the observation, YYYY-MM."
          },
          "index": {
            "type": "number",
            "minimum": 0,
            "description": "Consumer price index for the month, base 100 = average of 2017."
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "retrieved_at",
        "transformation_version",
        "sources",
        "pagination"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "prices-cpi"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "ODbL-1.0"
          ]
        },
        "retrieved_at": {
          "enum": [
            "2026-11-06"
          ]
        },
        "transformation_version": {
          "enum": [
            "1.0.0"
          ]
        },
        "sources": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dataset",
              "producer",
              "source_url",
              "resource_url",
              "license",
              "source_updated_at"
            ],
            "properties": {
              "dataset": {
                "type": "string"
              },
              "producer": {
                "type": "string"
              },
              "source_url": {
                "type": "string",
                "format": "uri"
              },
              "resource_url": {
                "type": "string",
                "format": "uri"
              },
              "license": {
                "enum": [
                  "ODbL-1.0"
                ]
              },
              "source_updated_at": {
                "type": "string",
                "format": "date"
              }
            }
          }
        },
        "pagination": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "limit",
            "offset",
            "count",
            "has_more",
            "next_offset"
          ],
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 1,
              "maximum": 500
            },
            "offset": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "count": {
              "type": "integer",
              "minimum": 0,
              "maximum": 500
            },
            "has_more": {
              "type": "boolean"
            },
            "next_offset": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 2147483647
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ]
            }
          }
        }
      }
    }
  }
}
المصادر وتقسيم الصفحات 19
metaobject

سياق النتيجة: المصادر والتواريخ والرخصة وتقسيم الصفحات عند الاقتضاء.

meta.datasetstring

اسم مجموعة البيانات الخاصة بالنتيجة أو المصدر.

القيم المقبولة: "prices-cpi"

meta.totalinteger

عدد النتائج المطابقة للمرشحات قبل تقسيم الصفحات؛ وليس حجم هذه الصفحة.

meta.licensestring

رخصة إعادة الاستخدام. تعني mixed وجود رخص مختلفة: راجع كل مصدر.

القيم المقبولة: "ODbL-1.0"

meta.retrieved_atstring

تاريخ جلب المشروع لملف المصدر؛ وليس تاريخ رصد البيانات.

القيم المقبولة: "2026-11-06"

meta.transformation_versionstring

إصدار قواعد تحويل مجموعة البيانات؛ مستقل عن إصدار الواجهة.

القيم المقبولة: "1.0.0"

meta.sourcesobject[]

المصادر المستخدمة لهذه النتيجة مع الجهات المنتجة والرخص.

meta.sources[].datasetstring

اسم مجموعة البيانات الخاصة بالنتيجة أو المصدر.

meta.sources[].producerstring

الجهة التي تنشر البيانات الأصلية.

meta.sources[].source_urlstring

صفحة نشر المصدر أو التعريف ببياناته.

meta.sources[].resource_urlstring

رابط الملف أو المورد المستخدم فعلياً.

meta.sources[].licensestring

رخصة إعادة الاستخدام. تعني mixed وجود رخص مختلفة: راجع كل مصدر.

القيم المقبولة: "ODbL-1.0"

meta.sources[].source_updated_atstring

آخر تحديث معلن من المصدر؛ وليس تاريخ جلب الملف.

meta.paginationobject

معلومات لتصفّح نتائج القائمة صفحة بصفحة.

meta.pagination.limitinteger

العدد الأقصى المطلوب في الصفحة: 100 افتراضياً و500 كحد أقصى.

meta.pagination.offsetinteger

عدد النتائج المتجاوزة قبل هذه الصفحة بعد التصفية. تبدأ الصفحة الأولى من 0.

meta.pagination.countinteger

عدد النتائج الموجودة فعلياً في هذه الصفحة.

meta.pagination.has_moreboolean

تكون true إذا بقيت صفحة أخرى من النتائج.

meta.pagination.next_offsetinteger | null

قيمة offset للصفحة التالية؛ null عند النهاية. احتفظ بالمرشحات نفسها.

الأخطاء
  • 400: معامل غير صالح أو مفقود.

تتضمن الأخطاء error.code وerror.message وerror.request_id.

errorobject

تفاصيل الطلب الفاشل؛ تحل محل data وmeta.

error.codestring

رمز ثابت للخطأ، مثل RESOURCE_NOT_FOUND؛ استعمله في منطق التطبيق.

error.messagestring

شرح مقروء للخطأ؛ استعمل code في منطق التطبيق.

error.request_idstring

معرّف هذا الطلب، يفيد عند الإبلاغ عن مشكلة.

طلبك

GET · JSON

العنوان الأساسي

الإجابة

ستظهر الإجابة الفعلية هنا.

تغيّر اللغة نص التوثيق فقط، دون مفاتيح JSON أو قيم المصادر.