{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMercantil Public Billing Companies API",
    "version": "1.4.0"
  },
  "items": [
    {
      "info": {
        "name": "Companies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get A Company Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path",
                "description": "Company slug, typically `{name}-{cif}`."
              }
            ]
          },
          "docs": "Return the structured company report for a known OpenMercantil slug."
        },
        {
          "info": {
            "name": "Get Paginated Company Events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/events",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              },
              {
                "name": "year",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Return BORME events for a known company slug, optionally filtered by year."
        },
        {
          "info": {
            "name": "List Company Officers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/officers",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "List officers (administrators, apoderados, auditors) currently or historically associated with the company."
        },
        {
          "info": {
            "name": "Export A Company Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/export",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              },
              {
                "name": "format",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Export a company report in JSON or CSV format."
        },
        {
          "info": {
            "name": "Get Company Score",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/score",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return the OpenMercantil composite company score (introduced in v1.1)."
        },
        {
          "info": {
            "name": "Get Company Activity Timeseries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/activity",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return a time series of registry activity events for the company (v1.1)."
        },
        {
          "info": {
            "name": "List Similar Companies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/similar",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Return companies similar to the given slug based on CNAE sector and structural signals (v1.1)."
        },
        {
          "info": {
            "name": "List Company Grants From BDNS",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/grants",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return public grants associated with the company from the BDNS dataset (v1.2)."
        },
        {
          "info": {
            "name": "List Company Sanctions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/sanctions",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return sanctions hits associated with the company from OpenSanctions and competition authorities (v1.2)."
        },
        {
          "info": {
            "name": "Get CNMV Records For Company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/cnmv",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return CNMV (Spanish securities regulator) records for the company (v1.2)."
        },
        {
          "info": {
            "name": "Geocode A Company Address",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/geocode",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "Set to 1 to bypass cache and force a live geocoding lookup."
              }
            ]
          },
          "docs": "Resolve the registered address of the company to coordinates via Nominatim/OSM with caching (v1.2). Use `force=1` to bypass the cache."
        },
        {
          "info": {
            "name": "Get Company Trust Score",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/trust-score",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return the OpenMercantil trust score combining BORME, CNMV, OEPM, PLACSP, BOE and sanctions signals (v1.4)."
        },
        {
          "info": {
            "name": "Get Company Relationship Network",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/network",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return the company's officer-and-shareholder relationship graph (v1.4)."
        },
        {
          "info": {
            "name": "List Company Embargoes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://openmercantil.es/api/v1/company/:slug/embargoes",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "List public embargoes (seizures) recorded against the company (v1.4)."
        }
      ]
    }
  ],
  "bundled": true
}