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

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

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

قائمة المؤسسات

GET/api/v2/banking/institutions

معلومة مهمة. ملفات أرسلها بنك المغرب في 4 نونبر 2026: قائمتان منفصلتان للمؤسسات والرموز البنكية دون مطابقة تلقائية. يشترط الميثاق ذكر المصدر وتاريخ النسخ؛ والاستعمال التجاري يتطلب إذناً كتابياً. تُحفظ البيانات الأصلية بالفرنسية.

المعاملات

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

البحث في الاسم وفي العنوان بالنسبة للمؤسسات؛ حرفان على الأقل دون تمييز حالة الأحرف أو اللكنات.

2-160 حرفاً
stringاختياري · الاستعلام

رمز الصنف من /banking/categories للمرجع نفسه.

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 القديمة أسماء بديلة متوافقة مع السلوك المنشور حالياً، بما فيه تقسيم الصفحات؛ لم يُحدد موعد لحذفها.

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

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

dataobject[]

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

data[].idstring

معرّف MoroccoAPI مشتق من اسم المصدر؛ ليس معرّفاً رسمياً لبنك المغرب.

data[].namestring

الاسم الفرنسي محفوظ كما ورد في ملف بنك المغرب.

data[].category_codestring

رمز الصنف لدى MoroccoAPI داخل هذا المرجع.

data[].category_namestring

اسم الصنف محفوظ كما أورده بنك المغرب.

data[].source_refobject

موضع المشاهدة داخل المصدر: ورقة/سطر أو حوض/ترتيب.

data[].source_ref.sheetstring

اسم ورقة ملف الجداول المصدر.

data[].source_ref.rowinteger

رقم السطر في ملف المصدر، بدءاً من 1.

data[].head_office_addressstring

عنوان المقر الاجتماعي من الملف الأصلي؛ لا يُستنتج منه موقع جغرافي.

بنية البيانات
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "name",
          "category_code",
          "category_name",
          "source_ref",
          "head_office_address"
        ],
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 200,
            "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "category_code": {
            "type": "string",
            "minLength": 1
          },
          "category_name": {
            "type": "string",
            "minLength": 1
          },
          "source_ref": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "sheet",
              "row"
            ],
            "properties": {
              "sheet": {
                "type": "string",
                "minLength": 1
              },
              "row": {
                "type": "integer",
                "minimum": 1
              }
            }
          },
          "head_office_address": {
            "type": "string",
            "minLength": 1
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "producer",
        "total",
        "received_at",
        "copied_at",
        "transformation_version",
        "license",
        "terms_url",
        "terms_section",
        "attribution",
        "notice",
        "reuse",
        "limitations",
        "sources",
        "pagination"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "bam-banking"
          ]
        },
        "producer": {
          "enum": [
            "Bank Al-Maghrib"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "received_at": {
          "type": "string",
          "format": "date"
        },
        "copied_at": {
          "type": "string",
          "format": "date"
        },
        "transformation_version": {
          "type": "string",
          "minLength": 1
        },
        "license": {
          "enum": [
            "LicenseRef-BAM-Charte-Diffusion"
          ]
        },
        "terms_url": {
          "type": "string",
          "format": "uri"
        },
        "terms_section": {
          "type": "string",
          "minLength": 1
        },
        "attribution": {
          "type": "string",
          "minLength": 1
        },
        "notice": {
          "type": "string",
          "minLength": 1
        },
        "reuse": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "non_commercial_use",
            "commercial_use",
            "modifications"
          ],
          "properties": {
            "non_commercial_use": {
              "enum": [
                "permitted-with-attribution-and-copy-date"
              ]
            },
            "commercial_use": {
              "enum": [
                "written-permission-required"
              ]
            },
            "modifications": {
              "enum": [
                "disclose-changes-and-BAM-non-liability"
              ]
            }
          }
        },
        "limitations": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "sources": {
          "type": "array",
          "minItems": 2,
          "maxItems": 2,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dataset",
              "filename",
              "sheet",
              "records",
              "reference_date",
              "date_basis",
              "sha256"
            ],
            "properties": {
              "dataset": {
                "type": "string",
                "enum": [
                  "institutions",
                  "bank-codes"
                ]
              },
              "filename": {
                "type": "string",
                "minLength": 1
              },
              "sheet": {
                "type": "string",
                "minLength": 1
              },
              "records": {
                "type": "integer",
                "minimum": 1
              },
              "reference_date": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date"
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "date_basis": {
                "type": "string",
                "minLength": 1
              },
              "sha256": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              }
            }
          }
        },
        "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
                  ]
                }
              ]
            }
          }
        }
      }
    }
  }
}
المصادر وتقسيم الصفحات 31
metaobject

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

meta.datasetstring

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

القيم المقبولة: "bam-banking"

meta.producerstring

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

القيم المقبولة: "Bank Al-Maghrib"

meta.totalinteger

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

meta.received_atstring

تاريخ رسالة بنك المغرب التي أرفقت الملفات، وهو مختلف عن تاريخ مرجع البيانات.

meta.copied_atstring

تاريخ النسخ المذكور ضمن بيان نسبة البيانات إلى بنك المغرب.

meta.transformation_versionstring

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

meta.licensestring

معرّف محلي لشروط ميثاق بنك المغرب؛ ليس رخصة مفتوحة معيارية.

القيم المقبولة: "LicenseRef-BAM-Charte-Diffusion"

meta.terms_urlstring

الميثاق الرسمي لبنك المغرب بشأن نشر البيانات والإحصاءات.

meta.terms_sectionstring

قسم الميثاق الذي يحدد شروط إعادة الاستخدام.

meta.attributionstring

بيان المصدر وتاريخ النسخ الواجب الاحتفاظ به عند إعادة الاستخدام.

meta.noticestring

بيان التحويلات التي أجرتها MoroccoAPI وعدم مسؤولية بنك المغرب عنها.

meta.reuseobject

ملخص شروط الميثاق؛ راجع النص المرتبط.

meta.reuse.non_commercial_usestring

إعادة الاستخدام غير التجاري مع ذكر بنك المغرب وتاريخ النسخ.

القيم المقبولة: "permitted-with-attribution-and-copy-date"

meta.reuse.commercial_usestring

الاستعمال التجاري وفق تعريف الميثاق يتطلب إذناً كتابياً من بنك المغرب.

القيم المقبولة: "written-permission-required"

meta.reuse.modificationsstring

الإفصاح عن التعديلات وإدراج بيان عدم مسؤولية بنك المغرب.

القيم المقبولة: "disclose-changes-and-BAM-non-liability"

meta.limitationsstring[]

القيود المعروفة للمصدر أو التغطية؛ اقرأها قبل استخدام البيانات.

meta.sourcesobject[]

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

meta.sources[].datasetstring

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

القيم المقبولة: "institutions" "bank-codes"

meta.sources[].filenamestring

اسم الملف المرفق الذي أرسله بنك المغرب.

meta.sources[].sheetstring

اسم ورقة ملف الجداول المصدر.

meta.sources[].recordsinteger

عدد السجلات في الملف الأصلي قبل التصفية.

meta.sources[].reference_datestring | null

تاريخ مرجع المصدر، أو null عند عدم تحديده؛ راجع date_basis.

meta.sources[].date_basisstring

source-filename: التاريخ من اسم الملف؛ not-stated-in-workbook: التاريخ غير مذكور في الملف.

meta.sources[].sha256string

بصمة SHA-256 لتحديد الملف المرفق الأصلي؛ ملف الجداول الخام غير مرفق.

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 أو قيم المصادر.