# GeoJSON

This driver implements read/write support for access to features encoded in GeoJSON format. The GeoJSON is a dialect based on the JavaScript Object Notation (JSON). The JSON is a lightweight plain text format for data interchange and GeoJSON is nothing other than its specialization for geographic content.

GeoJSON is supported as output format of a number of services : FeatureServer, GeoServer , CartoWeb, etc...

The OGR GeoJSON driver translates a GeoJSON encoded data to objects of OGR Simple Features model: Datasource, Layer, Feature, Geometry. The implementation is based on GeoJSON Specification, v1.0.

Starting with OGR 1.8.0, the GeoJSON driver can read the JSON output of Feature Service request following the GeoServices REST Specification, like implemented by ArcGIS Server REST API. And starting with OGR 2.0, the GeoJSON driver can scroll through such result sets that are spread over multiple pages (for ArcGIS servers >= 10.3). This is automatically enabled if URL does not contain an explicit resultOffset parameter. If it contains this parameter and scrolling is still desired, the FEATURE_SERVER_PAGING open option must be set to YES. The page size can be explicitly set with the resultRecordCount parameter (but is subject to a server limit). If it is not set, OGR will set it to the maximum value allowed by the server.

Starting with OGR 1.11, the GeoJSON driver can read the TopoJSON format

## Datasource

The OGR GeoJSON driver accepts three types of sources of data:

- Uniform Resource Locator (URL) - a Web address to perform HTTP request
- Plain text file with GeoJSON data - identified from the file extension .geojson or .json
- Text passed directly and encoded in GeoJSON

## Layer

A GeoJSON datasource is translated to single OGRLayer object with pre-defined name OGRGeoJSON:

    ogrinfo -ro http://featureserver/data/.geojson OGRGeoJSON

It's also valid to assume that OGRDataSource::GetLayerCount() for GeoJSON datasource always returns 1.

Accessing Web Service as a datasource (ie. FeatureServer), each request will produce new layer. This behavior conforms to stateless nature of HTTP transaction and is similar to how Web browsers operate: single request == single page.

If a top-level member of GeoJSON data is of any other type than FeatureCollection, the driver will produce a layer with only one feature. Otherwise, a layer will consists of a set of features.

## Feature

The OGR GeoJSON driver maps each object of following types to new OGRFeature object: Point, LineString, Polygon, GeometryCollection, Feature.

According to the GeoJSON Specification, only the Feature object must have a member with name properties. Each and every member of properties is translated to OGR object of type of OGRField and added to corresponding OGRFeature object.

The GeoJSON Specification does not require all Feature objects in a collection must have the same schema of properties. If Feature objects in a set defined by FeatureCollection object have different schema of properties, then resulting schema of fields in OGRFeatureDefn is generated as union of all Feature properties.

Schema detection will recognized fields of type String, Integer, Real, StringList, IntegerList and RealList. Starting with GDAL 2.0, Integer(Boolean), Date, Time and DateTime fields are also recognized.

It is possible to tell the driver to not to process attributes by setting environment variable ATTRIBUTES_SKIP=YES. Default behavior is to preserve all attributes (as an union, see previous paragraph), what is equal to setting ATTRIBUTES_SKIP=NO.

## Geometry

Similarly to the issue with mixed-properties features, the GeoJSON Specification draft does not require all Feature objects in a collection must have geometry of the same type. Fortunately, OGR objects model does allow to have geometries of different types in single layer - a heterogeneous layer. By default, the GeoJSON driver preserves type of geometries.

However, sometimes there is a need to generate homogeneous layer from a set of heterogeneous features. For this purpose, it's possible to tell the driver to wrap all geometries with OGRGeometryCollection type as a common denominator. This behavior may be controlled by setting environment variable GEOMETRY_AS_COLLECTION=YES (default is NO).

## Environment variables

- GEOMETRY_AS_COLLECTION - used to control translation of geometries: YES - wrap geometries with OGRGeometryCollection type
- ATTRIBUTES_SKIP - controls translation of attributes: YES - skip all attributes

## Open options

(GDAL >= 2.0)

- FLATTEN_NESTED_ATTRIBUTES = YES/NO : Whether to recursively explore nested objects and produce flatten OGR attributes. Defaults to NO.
- NESTED_ATTRIBUTE_SEPARATOR = character : Separator between components of nested attributes. Defaults to '_'
- FEATURE_SERVER_PAGING = YES/NO: Whether to automatically scroll through results with a ArcGIS Feature Service endpoint.

To explain FLATTEN_NESTED_ATTRIBUTES, consider the following GeoJSON fragment :

    {
      "type": "FeatureCollection",
      "features" :
      [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [ 2, 49 ]
          },
          "properties": {
            "a_property": "foo",
            "some_object": {
              "a_property": 1,
              "another_property": 2
            }
          }
        }
      ]
    }

"ogrinfo test.json -al -oo FLATTEN_NESTED_ATTRIBUTES=yes" reports :

    OGRFeature(OGRGeoJSON):0
      a_property (String) = foo
      some_object_a_property (Integer) = 1
      some_object_another_property (Integer) = 2
      POINT (2 49)

## Layer creation option

- WRITE_BBOX = YES/NO : (OGR >= 1.9.0) Set to YES to write a bbox property with the bounding box of the geometries at the feature and feature collection level. Defaults to NO.
- COORDINATE_PRECISION = int_number : (OGR >= 1.9.0) Maximum number of figures after decimal separator to write in coordinates. Default to 15. "Smart" truncation will occur to remove trailing zeros.

## VSI Virtual File System API support

(Some features below might require OGR >= 1.9.0)

The driver supports reading and writing to files managed by VSI Virtual File System API, which include "regular" files, as well as files in the /vsizip/ (read-write) , /vsigzip/ (read-write) , /vsicurl/ (read-only) domains.

Writing to /dev/stdout or /vsistdout/ is also supported.

## Example

How to dump content of .geojson file:

    ogrinfo -ro point.geojson

How to query features from remote service with filtering by attribute:

    ogrinfo -ro http://featureserver/cities/.geojson OGRGeoJSON -where "name=Warsaw"

How to translate number of features queried from FeatureServer to ESRI Shapefile:

    ogr2ogr -f "ESRI Shapefile" cities.shp http://featureserver/cities/.geojson OGRGeoJSON

Read the result of a FeatureService request against a GeoServices REST server:

    ogrinfo -ro -al "http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Hydrography/Watershed173811/FeatureServer/0/query?where=objectid+%3D+objectid&outfields=*&f=json"

## See Also

- GeoJSON - encoding geographic content in JSON
- JSON - JavaScript Object Notation
- JSON-C - A JSON implementation in C
- [Gdal-dev] OGR GeoJSON Driver - driver announcement
- GeoServices REST Specification