MoroccoAPIDocumentation
API reference

Choose a resource. Set the parameters. Try it.

No API keyJSON responsesOpen CORS

List stations and halts

GET/api/v2/transport/rail/stations

Good to know. Dated OpenStreetMap snapshot under ODbL. Missing names and cities are null. Includes inactive or planned sites; current passenger service and connections are not verified.

Parameters

06
stringOptional · Query

Search text, at least 2 characters.

2-100 characters
stringOptional · Query

Explicit OSM city; exact match ignoring case and accents. Coverage is incomplete.

2-100 characters
stringOptional · Query

station: railway station; halt: smaller rail stop.

stringOptional · Query

Lifecycle mapped in OSM. unknown does not mean the station is open.

integerOptional · Query

Results per page. Default 100, maximum 500.

Minimum: 1Maximum: 500Default: 100
integerOptional · Query

Matching results to skip. Starts at 0.

Minimum: 0Maximum: 2147483647Default: 0
Read the response

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

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

meta.pagination: Lists: 100 results by default, 500 maximum. Use limit and offset; meta.pagination.next_offset is null on the last page.

Illustrative example: With limit=10 and offset=0, the first page holds at most 10 results. If next_offset is 10, request the next page with offset=10 and the same filters. Stop when next_offset is null.

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 27

[] 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[].idstring

Primary OSM object identifier, not an ONCF or UIC code.

data[].namestring | null

Resource name, grouped by language where applicable.

data[].namesobject

Explicit OSM language tags; no generated translations.

data[].names.arstring | null

Arabic value; null when no translation is provided.

data[].names.frstring | null

French value; null when no translation is provided.

data[].names.enstring | null

English value; null when no translation is provided.

data[].aliasesstring[]

Alternative names for the same resource, useful for recognition or search.

data[].typestring

station: railway station; halt: smaller rail stop.

Accepted values: "station" "halt"

data[].citystring | null

City explicitly tagged addr:city or is_in:city in OSM; null if absent.

data[].operatorstring | null

Operator recorded in OSM, without current official confirmation.

data[].networkstring | null

Network label recorded in OSM, where present.

data[].locationobject

Source geographic coordinates, where available.

data[].location.latitudenumber

WGS 84 latitude in decimal degrees: positive north, negative south.

data[].location.longitudenumber

WGS 84 longitude in decimal degrees: positive east, negative west.

data[].location.methodstring

osm_point: source point; bounding_box_center: extent center, not an entrance.

Accepted values: "osm_point" "bounding_box_center"

data[].osm_statusstring

Explicit OSM lifecycle; unknown does not confirm operation.

Accepted values: "unknown" "disused" "abandoned" "construction" "proposed" "demolished"

data[].wikidata_idstring | null

Wikidata identifier tagged in OSM; no external enrichment.

data[].passenger_servicenull

null: current passenger service is unverified.

Accepted values: null

data[].connectionsnull

null: connections unavailable, not an empty list proving no connections.

Accepted values: null

data[].sourcesobject[]

OSM evidence for this record; the first determines its identifier and position.

data[].sources[].osm_typestring

OpenStreetMap object type: node, way or relation.

Accepted values: "node" "way" "relation"

data[].sources[].osm_idinteger

OSM numeric identifier, interpreted together with osm_type.

data[].sources[].versioninteger

OSM object version in this extract.

data[].sources[].updated_atstring

Last OSM edit of this object; not an on-site verification.

data[].sources[].urlstring

Link to the OSM object; its online version may have changed.

data[].sources[].fieldsstring[]

Normalized record fields contributed by this source object.

Data structure
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "name",
          "names",
          "aliases",
          "type",
          "city",
          "operator",
          "network",
          "location",
          "osm_status",
          "wikidata_id",
          "passenger_service",
          "connections",
          "sources"
        ],
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^osm-(node|way|relation)-[1-9][0-9]*$"
          },
          "name": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ]
          },
          "names": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "ar",
              "fr",
              "en"
            ],
            "properties": {
              "ar": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 1
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "fr": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 1
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "en": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 1
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              }
            }
          },
          "aliases": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "station",
              "halt"
            ]
          },
          "city": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ],
            "description": "Explicit OSM addr:city or is_in:city, not a geocoded administrative assignment."
          },
          "operator": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ]
          },
          "network": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ]
          },
          "location": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "latitude",
              "longitude",
              "method"
            ],
            "properties": {
              "latitude": {
                "type": "number",
                "minimum": -90,
                "maximum": 90
              },
              "longitude": {
                "type": "number",
                "minimum": -180,
                "maximum": 180
              },
              "method": {
                "type": "string",
                "enum": [
                  "osm_point",
                  "bounding_box_center"
                ]
              }
            }
          },
          "osm_status": {
            "type": "string",
            "enum": [
              "unknown",
              "disused",
              "abandoned",
              "construction",
              "proposed",
              "demolished"
            ],
            "description": "Explicit source lifecycle only; unknown is not confirmation of current service."
          },
          "wikidata_id": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^Q[1-9][0-9]*$"
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ]
          },
          "passenger_service": {
            "type": "string",
            "description": "Current passenger service is not verified.",
            "nullable": true,
            "enum": [
              null
            ]
          },
          "connections": {
            "type": "string",
            "description": "Unavailable, not an empty set of connections. No timetable feed is integrated.",
            "nullable": true,
            "enum": [
              null
            ]
          },
          "sources": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "osm_type",
                "osm_id",
                "version",
                "updated_at",
                "url",
                "fields"
              ],
              "properties": {
                "osm_type": {
                  "type": "string",
                  "enum": [
                    "node",
                    "way",
                    "relation"
                  ]
                },
                "osm_id": {
                  "type": "integer",
                  "minimum": 1
                },
                "version": {
                  "type": "integer",
                  "minimum": 1
                },
                "updated_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "OSM edit timestamp, not a verification of current service."
                },
                "url": {
                  "type": "string",
                  "format": "uri"
                },
                "fields": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 1
                  }
                }
              }
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "license_url",
        "attribution",
        "snapshot_at",
        "retrieved_at",
        "transformation_version",
        "source_record_count",
        "snapshot_record_count",
        "scope",
        "limitations",
        "sources",
        "pagination"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "osm-geofabrik-morocco-rail"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "ODbL-1.0"
          ]
        },
        "license_url": {
          "enum": [
            "https://opendatacommons.org/licenses/odbl/1-0/"
          ]
        },
        "attribution": {
          "enum": [
            "© OpenStreetMap contributors"
          ]
        },
        "snapshot_at": {
          "enum": [
            "2026-11-13T21:22:20Z"
          ]
        },
        "retrieved_at": {
          "enum": [
            "2026-11-14"
          ]
        },
        "transformation_version": {
          "enum": [
            "1.0.0"
          ]
        },
        "source_record_count": {
          "enum": [
            178
          ]
        },
        "snapshot_record_count": {
          "enum": [
            151
          ]
        },
        "scope": {
          "type": "string",
          "minLength": 1
        },
        "limitations": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "sources": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "producer",
              "source_url",
              "resource_url",
              "license",
              "source_updated_at",
              "sha256"
            ],
            "properties": {
              "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-time"
              },
              "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
                  ]
                }
              ]
            }
          }
        }
      }
    }
  }
}
Sources and pagination 26
metaobject

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

meta.datasetstring

Name of the dataset for this result or source.

Accepted values: "osm-geofabrik-morocco-rail"

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.

Accepted values: "https://opendatacommons.org/licenses/odbl/1-0/"

meta.attributionstring

Required attribution for the OSM data.

Accepted values: "© OpenStreetMap contributors"

meta.snapshot_atstring

OSM extract timestamp, separate from individual object edits.

Accepted values: "2026-11-13T21:22:20Z"

meta.retrieved_atstring

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

Accepted values: "2026-11-14"

meta.transformation_versionstring

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

Accepted values: "1.0.0"

meta.source_record_countnumber

Number of source records before any API filters.

Accepted values: 178

meta.snapshot_record_countnumber

Snapshot records after exclusions and reviewed merges, before request filters.

Accepted values: 151

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[]

Origin and license of the downloaded extract.

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.

meta.sources[].sha256string

SHA-256 checksum of the complete source PBF file.

meta.paginationobject

Information for reading a collection one page at a time.

meta.pagination.limitinteger

Requested maximum records per page: default 100, maximum 500.

meta.pagination.offsetinteger

Matching records skipped before this page, after filtering. The first page starts at 0.

meta.pagination.countinteger

Number of records actually returned on this page.

meta.pagination.has_moreboolean

true when another page of records remains.

meta.pagination.next_offsetinteger | null

Use as offset for the next page; null at the end. Keep the same filters.

Errors
  • 400: Invalid or missing parameter.

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.

Your request

GET · JSON

Base URL

Response

The live response will appear here.

Language changes the guide, not JSON keys or source values.