Ports & lighthouses/API v2

Get a port by name

GET/api/v2/ports/{name}

Good to know. Ministry of Equipment and Water lists. Source names and fields remain in French.

Read the response

data: The requested results, as an object or an array.

meta: Dataset sources, license and dates. null means unknown or unavailable.

API v2 is the canonical path. Older /api/v1 paths remain compatibility aliases for the currently published behavior, including pagination; no removal date is scheduled.

Response fields 7

[] means each item in a list. null means unknown or unavailable, never zero. The guide language does not translate source values.

dataobject: Requested result: a single object or a list.
data.Nom du portstring: Port name as published; the French JSON key is preserved.
data.Type de portsstring: Port category stated in the source.
data.Connectivitéstring: Maritime connectivity information provided by the source.
data.Latitudenumber: WGS 84 latitude in decimal degrees: positive north, negative south.
data.Longitudenumber: WGS 84 longitude in decimal degrees: positive east, negative west.
data.Etatstring: Port state described in the source file; not live monitoring.

Data structure

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "Nom du port",
        "Type de ports",
        "Connectivité",
        "Latitude",
        "Longitude",
        "Etat"
      ],
      "properties": {
        "Nom du port": {
          "type": "string",
          "minLength": 1
        },
        "Type de ports": {
          "type": "string",
          "minLength": 1
        },
        "Connectivité": {
          "type": "string",
          "minLength": 1
        },
        "Latitude": {
          "type": "number",
          "minimum": -90,
          "maximum": 90
        },
        "Longitude": {
          "type": "number",
          "minimum": -180,
          "maximum": 180
        },
        "Etat": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "license_url",
        "retrieved_at",
        "source_updated_at",
        "transformation_version",
        "scope",
        "limitations",
        "sources"
      ],
      "properties": {
        "dataset": {
          "type": "string",
          "enum": [
            "morocco-ports",
            "morocco-lighthouses"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "ODbL-1.0"
          ]
        },
        "license_url": {
          "type": "string",
          "format": "uri"
        },
        "retrieved_at": {
          "type": "string",
          "format": "date"
        },
        "source_updated_at": {
          "type": "string",
          "format": "date"
        },
        "transformation_version": {
          "type": "string"
        },
        "scope": {
          "type": "string",
          "minLength": 1
        },
        "limitations": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "sources": {
          "type": "array",
          "minItems": 1,
          "maxItems": 1,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dataset",
              "producer",
              "source_url",
              "resource_url",
              "license",
              "source_updated_at"
            ],
            "properties": {
              "dataset": {
                "type": "string",
                "minLength": 1
              },
              "producer": {
                "type": "string",
                "minLength": 1
              },
              "source_url": {
                "type": "string",
                "format": "uri"
              },
              "resource_url": {
                "type": "string",
                "format": "uri"
              },
              "license": {
                "enum": [
                  "ODbL-1.0"
                ]
              },
              "source_updated_at": {
                "type": "string",
                "format": "date"
              }
            }
          }
        }
      }
    }
  }
}

Sources and pagination 17

metaobject

Result context: sources, dates, license and pagination where applicable.

meta.datasetstring

Name of the dataset for this result or source.

Accepted values: "morocco-ports" "morocco-lighthouses"

meta.totalinteger

Number of matching records before pagination; not the size of this page.

meta.licensestring

Reuse license. mixed means licenses differ: inspect each source.

Accepted values: "ODbL-1.0"

meta.license_urlstring

Link to the license terms; null when no URL is supplied.

meta.retrieved_atstring

Date the project retrieved the source file; not the observation date.

meta.source_updated_atstring

Last update reported by the source; not the retrieval date.

meta.transformation_versionstring

Version of the dataset conversion rules; separate from the API version.

meta.scopestring

Scope covered by the dataset; does not imply universal coverage.

meta.limitationsstring[]

Known source or coverage limitations; read before using the data.

meta.sourcesobject[]

Sources used for this result, with their publishers and licenses.

meta.sources[].datasetstring

Name of the dataset for this result or source.

meta.sources[].producerstring

Organization publishing the original data.

meta.sources[].source_urlstring

Source publication or dataset landing page.

meta.sources[].resource_urlstring

Link to the actual file or resource used.

meta.sources[].licensestring

Reuse license. mixed means licenses differ: inspect each source.

Accepted values: "ODbL-1.0"

meta.sources[].source_updated_atstring

Last update reported by the source; not the retrieval date.

Errors

400: Invalid or missing parameter.
404: Resource not found.

Errors return error.code, error.message and error.request_id.

errorobject: Details of a failed request; replaces data and meta.
error.codestring: Stable error code, such as RESOURCE_NOT_FOUND; use it in application logic.
error.messagestring: Human-readable error explanation; use code for application logic.
error.request_idstring: Identifier for this request, useful when reporting a problem.

Get a port by name

Parameters

Your request