<commit_before>API catalog
===========

<a name="coverage"></a>Coverage
-------------------------------

Also known as `/coverage` service.

You can easily navigate through regions covered by navitia.io, with the
coverage api. The shape of the region is provided in GeoJSON.

The only arguments are the ones of [paging](#paging).

### Accesses

| url | Result |
|----------------------------------------------|-------------------------------------|
| `coverage`                              | List of the areas covered by navitia|
| `coverage/{region_id}`                  | Information about a specific region |
| `coverage/{region_id}/coords/{lon;lat}` | Information about a specific region |


<a name="coord"></a>Inverted geocoding
--------------------------------------
``` shell
#request 
$ curl 'https://api.navitia.io/v1/coords/2.37705;48.84675' -H 'Authorization: <PASSWORD>'

#response where you can find the right Navitia coverage, and a useful label
HTTP/1.1 200 OK

{
    "regions": [
        "sandbox"
    ],
    "address": {
        "id": "2.37705;48.84675",
        "label": "20 Rue Hector Malot (Paris)",
        "...": "..."
    }
}
```

> in this example, the coverage id is "regions": ["sandbox"] 
so you can ask Navitia on accessible local mobility services:

``` shell
#request
$ curl 'https://api.navitia.io/v1/coverage/sandbox' -H 'Authorization: <PASSWORD>'

#response
HTTP/1.1 200 OK

{
    "regions": [{
        "status": "running",
        "start_production_date": "20160101","end_production_date": "20160831",
        "id": "sandbox"
    }],
    "links": [
        {"href": "https://api.navitia.io/v1/coverage/sandbox/coords"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/places"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/networks"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/physical_modes"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/companies"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/commercial_modes"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/lines"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/routes"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/stop_areas"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/stop_points"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/line_groups"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/connections"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/vehicle_journeys"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/poi_types"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/pois"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/disruptions"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/datasets"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/line_groups"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/trips"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/"}
    ]
}

```

Also known as `/coords` service.

Very simple service: you give Navitia some coordinates, it answers you

-   your detailed postal address
-   the right Navitia "coverage" which allows you to access to all known
    local mobility services

You can also combine `/coords` with other filter as : 

-   get [POIs](#poi) near a coordinate
	- <https://api.navitia.io/v1/coverage/fr-idf/coords/2.377310;48.847002/pois?distance=1000>
-   get specific POIs near a coordinate
	- <https://api.navitia.io/v1/coverage/fr-idf/poi_types/poi_type:amenity:bicycle_rental/coords/2.377310;48.847002/pois?distance=1000>



<a name="pt-ref"></a>Public Transportation Objects exploration
--------------------------------------------------------------

Also known as `/networks`, `/lines`, `/stop_areas`... services.


Once you have selected a region, you can explore the public
transportation objects easily with these APIs. You just need to add at
the end of your URL a collection name to see every objects within a
particular collection. To see an object detail, add the id of this object at the
end of the collection's URL. The [paging](#paging) arguments may be used to
paginate results.

### Accesses

| url | Result |
|---------------------------------------------------------|-------------------------------------|
| `/coverage/{region_id}/{collection_name}`               | Collection of objects of a region   |
| `/coverage/{region_id}/{collection_name}/{object_id}`   | Information about a specific region |
| `/coverage/{lon;lat}/{collection_name}`                 | Collection of objects of a region   |
| `/coverage/{lon;lat}/{collection_name}/{object_id}`     | Information about a specific region |

### Collections

-   [networks](#network)
-   [lines](#line)
-   [routes](#route)
-   [stop_points](#stop-point)
-   [stop_areas](#stop-area)
-   [commercial_modes](#commercial-mode)
-   [physical_modes](#physical-mode)
-   [companies](#company)
-   [vehicle_journeys](#vehicle-journey)
-   [disruptions](#disruption)

### Parameters

``` shell
curl 'https://api.navitia.io/v1/coverage/sandbox/pt_objects?q=metro%201' -H 'Authorization: 3b036afe-0110-4202-b9ed-99718476c2e0'

HTTP/1.1 200 OK

{
    "pt_objects":[
        {
            "id":"line:RAT:M1",
            "name":"RATP Metro 1 (Château de Vincennes - La Défense)",
            "embedded_type":"line",
            "line":{
                "id":"line:RAT:M1",
                "name":"Château de Vincennes - La Défense",
                "code":"1",
                "...": "..."
            }
        },
        {
            "id":"line:RAT:M11",
            "name":"RATP Metro 11 (Mairie des Lilas - Châtelet)"
            "embedded_type":"line",
            "line":{
                "...": "..."
            },
        },
        {
            "id":"line:RAT:M12",
            "name":"RATP Metro 12 (Mairie d'Issy - Front Populaire)",
            "embedded_type":"line",
            "line":{
                "...": "..."
            }
        },
        {"...": "..."},
        {"...": "..."}
    ]
}
```

#### <a name="depth"></a>depth

This tiny parameter can expand Navitia power by making it more wordy.
Here is some examples around "metro line 1" from the Parisian network:

- Get "line 1" id
	- <https://api.navitia.io/v1/coverage/sandbox/pt_objects?q=metro%201>
	- The id is "line:RAT:M1"
- Get routes for this line
	- <https://api.navitia.io/v1/coverage/sandbox/lines/line:RAT:M1/routes>
- Want to get a tiny response? Just add "depth=0"
	- <https://api.navitia.io/v1/coverage/sandbox/lines/line:RAT:M1/routes?depth=0>
	- The response is lighter (parent lines disappear for example)
- Want more informations, just add "depth=2"
	- <https://api.navitia.io/v1/coverage/sandbox/lines/line:RAT:M1/routes?depth=2>
	- The response is a little more verbose (with some geojson appear in response)
- Wanna fat more informations, let's try "depth=3"
	- <https://api.navitia.io/v1/coverage/sandbox/lines/line:RAT:M1/routes?depth=3>
	- Big response: all stop_points are shown
- Wanna spam the internet bandwidth? Try "depth=42"
	- No. There is a technical limit with "depth=3"

#### odt level

-   Type: String<commit_msg>add notice for geojson available using real data<commit_after>API catalog
===========

<a name="coverage"></a>Coverage
-------------------------------

Also known as `/coverage` service.

You can easily navigate through regions covered by navitia.io, with the
coverage api. The shape of the region is provided in GeoJSON.

The only arguments are the ones of [paging](#paging).

### Accesses

| url | Result |
|----------------------------------------------|-------------------------------------|
| `coverage`                              | List of the areas covered by navitia|
| `coverage/{region_id}`                  | Information about a specific region |
| `coverage/{region_id}/coords/{lon;lat}` | Information about a specific region |


<a name="coord"></a>Inverted geocoding
--------------------------------------
``` shell
#request 
$ curl 'https://api.navitia.io/v1/coords/2.37705;48.84675' -H 'Authorization: 3b036afe-0110-4202-b9ed-99718476c2e0'

#response where you can find the right Navitia coverage, and a useful label
HTTP/1.1 200 OK

{
    "regions": [
        "sandbox"
    ],
    "address": {
        "id": "2.37705;48.84675",
        "label": "20 Rue Hector Malot (Paris)",
        "...": "..."
    }
}
```

> in this example, the coverage id is "regions": ["sandbox"] 
so you can ask Navitia on accessible local mobility services:

``` shell
#request
$ curl 'https://api.navitia.io/v1/coverage/sandbox' -H 'Authorization: <PASSWORD>'

#response
HTTP/1.1 200 OK

{
    "regions": [{
        "status": "running",
        "start_production_date": "20160101","end_production_date": "20160831",
        "id": "sandbox"
    }],
    "links": [
        {"href": "https://api.navitia.io/v1/coverage/sandbox/coords"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/places"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/networks"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/physical_modes"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/companies"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/commercial_modes"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/lines"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/routes"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/stop_areas"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/stop_points"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/line_groups"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/connections"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/vehicle_journeys"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/poi_types"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/pois"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/disruptions"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/datasets"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/line_groups"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/trips"},
        {"href": "https://api.navitia.io/v1/coverage/sandbox/"}
    ]
}

```

Also known as `/coords` service.

Very simple service: you give Navitia some coordinates, it answers you

-   your detailed postal address
-   the right Navitia "coverage" which allows you to access to all known
    local mobility services

You can also combine `/coords` with other filter as : 

-   get [POIs](#poi) near a coordinate
	- <https://api.navitia.io/v1/coverage/fr-idf/coords/2.377310;48.847002/pois?distance=1000>
-   get specific POIs near a coordinate
	- <https://api.navitia.io/v1/coverage/fr-idf/poi_types/poi_type:amenity:bicycle_rental/coords/2.377310;48.847002/pois?distance=1000>



<a name="pt-ref"></a>Public Transportation Objects exploration
--------------------------------------------------------------

Also known as `/networks`, `/lines`, `/stop_areas`... services.


Once you have selected a region, you can explore the public
transportation objects easily with these APIs. You just need to add at
the end of your URL a collection name to see every objects within a
particular collection. To see an object detail, add the id of this object at the
end of the collection's URL. The [paging](#paging) arguments may be used to
paginate results.

### Accesses

| url | Result |
|---------------------------------------------------------|-------------------------------------|
| `/coverage/{region_id}/{collection_name}`               | Collection of objects of a region   |
| `/coverage/{region_id}/{collection_name}/{object_id}`   | Information about a specific region |
| `/coverage/{lon;lat}/{collection_name}`                 | Collection of objects of a region   |
| `/coverage/{lon;lat}/{collection_name}/{object_id}`     | Information about a specific region |

### Collections

-   [networks](#network)
-   [lines](#line)
-   [routes](#route)
-   [stop_points](#stop-point)
-   [stop_areas](#stop-area)
-   [commercial_modes](#commercial-mode)
-   [physical_modes](#physical-mode)
-   [companies](#company)
-   [vehicle_journeys](#vehicle-journey)
-   [disruptions](#disruption)

### Parameters

``` shell
curl 'https://api.navitia.io/v1/coverage/sandbox/pt_objects?q=metro%201' -H 'Authorization: 3b036afe-0110-4202-b9ed-99718476c2e0'

HTTP/1.1 200 OK

{
    "pt_objects":[
        {
            "id":"line:RAT:M1",
            "name":"RATP Metro 1 (Château de Vincennes - La Défense)",
            "embedded_type":"line",
            "line":{
                "id":"line:RAT:M1",
                "name":"Château de Vincennes - La Défense",
                "code":"1",
                "...": "..."
            }
        },
        {
            "id":"line:RAT:M11",
            "name":"RATP Metro 11 (Mairie des Lilas - Châtelet)"
            "embedded_type":"line",
            "line":{
                "...": "..."
            },
        },
        {
            "id":"line:RAT:M12",
            "name":"RATP Metro 12 (Mairie d'Issy - Front Populaire)",
            "embedded_type":"line",
            "line":{
                "...": "..."
            }
        },
        {"...": "..."},
        {"...": "..."}
    ]
}
```

#### <a name="depth"></a>depth

This tiny parameter can expand Navitia power by making it more wordy.
Here is some examples around "metro line 1" from the Parisian network:

- Get "line 1" id
	- <https://api.navitia.io/v1/coverage/sandbox/pt_objects?q=metro%201>
	- The id is "line:RAT:M1"
- Get routes for this line
	- <https://api.navitia.io/v1/coverage/sandbox/lines/line:RAT:M1/routes>
- Want to get a tiny response? Just add "depth=0"
	- <https://api.navitia.io/v1/coverage/sandbox/lines/line:RAT:M1/routes?depth=0>
	- The response is lighter (parent lines disappear for example)
- Want more informations, just add "depth=2"
	- <https://api.navitia.io/v1/coverage/sandbox/lines/line:RAT:M1/routes?depth=2>
	- The response is a little more verbose (with some geojson could appear in response using your open data token)
- Wanna fat more informations, let's try "depth=3"
	- <https://api.navitia.io/v1/coverage/sandbox/lines/line:RAT:M1/routes?depth=3>
	- Big response: all stop_points are shown
- Wanna spam the internet bandwidth? Try "depth=42"
	- No. There is a technical limit with "depth=3"

#### odt level

-   Type: String
{'fraction_non_alphanumeric': 0.2021655701754386, 'fraction_numerical': 0.02679550438596491, 'mean_word_length': 2.441745283018868, 'pattern_counts': {'":': 106, '<': 36, '<?xml version=': 0, '>': 38, 'https://': 60, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2001029', 'n_tokens_mistral': 5188, 'n_tokens_neox': 4811, 'n_words': 1046}