API reference

API overview

Find cell positions, query an area, and submit measurements.

Base URL

https://opencellid.org

Most operations require an API key, supplied as key. Request methods and parameter placement are described on each endpoint page.

Attribution required

When sharing OpenCellID data under CC BY-SA 4.0, credit OpenCelliD and link to the source and license. Attribution helps people discover and contribute to the project. See License and attribution for credit text, placement guidance and how to request an exception.

This license covers cell data returned by the API as well as dataset downloads.

Read cell data

OperationPathDocumentation
Get a cell position/cell/getCell position
List cells in an area/cell/getInAreaCells in an area
Count cells in an area/cell/getInAreaSizeCell count

Submit observations

OperationPathDocumentation
Add one measurement/measure/addAdd a measurement
Upload a CSV file/measure/uploadCsvCSV upload
Upload a JSON file/measure/uploadJsonJSON upload
Upload a CLF file/measure/uploadClfCLF upload

Request and response formats

Supported formats and defaults vary by endpoint. Cell lookup documents XML as its default; area lookup documents KML. Select format=json explicitly when you want JSON from a supported read endpoint.

File uploads use multipart form data. A JSON upload is a file in the datafile field, accompanied by the key field; see the endpoint's cURL example.

Errors and data fields

On this page