API - Revision history

Admin: /* Availability */

2025-04-16T10:17:28Z

‎Availability

Admin: /* Availability */

2025-04-16T10:15:50Z

‎Availability

Admin: /* Payload */

2025-04-16T10:12:19Z

‎Payload

Admin: /* Example */

2025-04-16T10:06:37Z

‎Example

Admin: /* Payload */ removing radio as its not supported in the getInAreaSize endpoint atm

2025-04-16T10:06:18Z

‎Payload: removing radio as its not supported in the getInAreaSize endpoint atm

Admin: /* Payload */

2025-04-15T13:12:00Z

‎Payload

Admin: https links

2024-10-25T03:49:21Z

https links

Admin: Changed urls to https

2024-10-25T03:45:23Z

Changed urls to https

Admin: /* removed old app link and added webserviceurl */

2024-10-25T03:35:33Z

‎removed old app link and added webserviceurl

Admin: /* API key */

2023-07-14T09:35:41Z

‎API key

@@ Line 1,676: / Line 1,676: @@
 ===Availability===
-This feature is available free of charge in case your application contributes data to OpenCellID at the same time.<br>
+* Each API request counts as 2 API request credits.
-In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
+* This feature is available free of charge for applications that contribute data to OpenCellID
-An automated check for providing this service to white-listed apiKeys only was activated on Jun 15th, 2014
+* If you want to use this service without contributing to OpenCellID, please refer to <u>[[Commercial_users|the commercial users guideline]]</u>
 <!--

@@ Line 1,579: / Line 1,579: @@
 ===Availability===
-This feature is available free of charge in case your application contributes data to OpenCellID at the same time.<br>
+* This feature is available free of charge for applications that contribute data to OpenCellID
-In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
+* Each cell returned counts as 1 API request credit. We recommend using the getInAreaSize endpoint first to check how many cells to expect before querying this endpoint
-An automated check for providing this service to white-listed apiKeys only was activated on Jun 15th, 2014
+* In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
 ==Getting the number of cells in a specified area==

@@ Line 1,351: / Line 1,351: @@
 | title="Parameter" | <limit>
 | title="Data type" | integer
-| title="Description" | A number defining maximum size of the returned list. Default and maximum value is 50.
+| title="Description" | A number defining maximum size of the returned list. Default and maximum value is 50. Use together with <code>offset</code> for paginating through large result sets.
 | title="Optional" | yes
 |-
 | title="Parameter" | <offset>
 | title="Data type" | integer
-| title="Description" | The field says to skip that many cells before beginning to return cells. Default is 0.
+| title="Description" | The number of items to skip before beginning to return results. Default is 0. Use together with <code>limit</code> for pagination (e.g., for page 2 with 20 items per page, use <code>offset=20</code>). Note: Since the database is updated minutely, the order of cells may change between API calls. For more consistent results when paginating through large datasets, consider using smaller bounding boxes when the getInAreaSize endpoint indicates a large number of cells.
 | title="Optional" | yes
 |-

@@ Line 1,673: / Line 1,673: @@
 ===Example===
 <u>https://www.opencellid.org/cell/getInAreaSize?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070</u><br>
-<u>https://www.opencellid.org/cell/getInAreaSize?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070&radio=CDMA&format=json</u>
+<u>https://www.opencellid.org/cell/getInAreaSize?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070&format=json</u>
 ===Availability===

@@ Line 1,643: / Line 1,643: @@
 | title="Data type" | integer
 | title="Description" | Local area code, tracking area code or network id; If you want to restrict the result
 | title="Optional" | yes
 |-

@@ Line 410: / Line 410: @@
 | title="Error code" | 7
 | title="HTTP code" | 429
-| title="Description " | Daily limit 1000 requests exceeded for your API key.<br><br>For further details please visit:<br>http://wiki.opencellid.org/wiki/Commercial_users<br><br>You can alternatively download the database here:<br>https://opencellid.org/downloads/
+| title="Description " | Daily limit 1000 requests exceeded for your API key.<br><br>For further details please visit:<br>https://wiki.opencellid.org/wiki/Commercial_users<br><br>You can alternatively download the database here:<br>https://opencellid.org/downloads/
 |}
@@ Line 417: / Line 417: @@
 GET/POST request to
 <pre>
-http://<WebServiceURL>/measure/add
+https://<WebServiceURL>/measure/add
 </pre>
@@ Line 459: / Line 459: @@
 POST request to
 <pre>
-http://<WebServiceURL>/measure/uploadCsv
+https://<WebServiceURL>/measure/uploadCsv
 </pre>
@@ Line 546: / Line 546: @@
 POST request to
 <pre>
-http://<WebServiceURL>/measure/uploadJson
+https://<WebServiceURL>/measure/uploadJson
 </pre>
@@ Line 711: / Line 711: @@
 POST request to
 <pre>
-http://<WebServiceURL>/measure/uploadClf
+https://<WebServiceURL>/measure/uploadClf
 </pre>
@@ Line 813: / Line 813: @@
 GET/POST request to
 <pre>
-http://<WebServiceURL>/cell/get
+https://<WebServiceURL>/cell/get
 </pre>
@@ Line 1,001: / Line 1,001: @@
 GET/POST request to
 <pre>
-http://<WebServiceURL>/cell/getMeasures
+https://<WebServiceURL>/cell/getMeasures
 </pre>
@@ Line 1,187: / Line 1,187: @@
 ===Example===
-<u>http://www.opencellid.org/cell/getMeasures?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&limit=10&offset=1</u><br>
+<u>https://www.opencellid.org/cell/getMeasures?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&limit=10&offset=1</u><br>
-<u>http://www.opencellid.org/cell/getMeasures?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&radio=UMTS&limit=10&offset=1&format=json</u>
+<u>https://www.opencellid.org/cell/getMeasures?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&radio=UMTS&limit=10&offset=1&format=json</u>
 ===Availability===
@@ Line 1,199: / Line 1,199: @@
 GET/POST request to
 <pre>
-http://<WebServiceURL>/cell/getMeasuresSize
+https://<WebServiceURL>/cell/getMeasuresSize
 </pre>
@@ Line 1,274: / Line 1,274: @@
 ===Example===
-<u>http://www.opencellid.org/cell/getMeasuresSize?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&radio=GSM</u><br>
+<u>https://www.opencellid.org/cell/getMeasuresSize?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&radio=GSM</u><br>
-<u>http://www.opencellid.org/cell/getMeasuresSize?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&format=json</u>
+<u>https://www.opencellid.org/cell/getMeasuresSize?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&format=json</u>
 ===Availability===
@@ Line 1,286: / Line 1,286: @@
 GET request to
 <pre>
-http://<WebServiceURL>/cell/getInArea
+https://<WebServiceURL>/cell/getInArea
 </pre>
@@ Line 1,575: / Line 1,575: @@
 ===Example===
-<u>http://www.opencellid.org/cell/getInArea?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070&limit=4&offset=16&format=kml</u><br>
+<u>https://www.opencellid.org/cell/getInArea?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070&limit=4&offset=16&format=kml</u><br>
-<u>http://www.opencellid.org/cell/getInArea?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070&radio=CDMA&limit=4&offset=16&format=json</u>
+<u>https://www.opencellid.org/cell/getInArea?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070&radio=CDMA&limit=4&offset=16&format=json</u>
 ===Availability===
@@ Line 1,587: / Line 1,587: @@
 GET request to
 <pre>
-http://<WebServiceURL>/cell/getInAreaSize
+https://<WebServiceURL>/cell/getInAreaSize
 </pre>
@@ Line 1,677: / Line 1,677: @@
 ===Example===
-<u>http://www.opencellid.org/cell/getInAreaSize?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070</u><br>
+<u>https://www.opencellid.org/cell/getInAreaSize?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070</u><br>
-<u>http://www.opencellid.org/cell/getInAreaSize?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070&radio=CDMA&format=json</u>
+<u>https://www.opencellid.org/cell/getInAreaSize?key=xxx&BBOX=52.0,21.0,52.5,21.5&mcc=260&mnc=2&lac=45070&radio=CDMA&format=json</u>
 ===Availability===
@@ Line 1,690: / Line 1,690: @@
 POST request to
 <pre>
-http://<WebServiceURL>/measure/delete
+https://<WebServiceURL>/measure/delete
 </pre>
@@ Line 1,729: / Line 1,729: @@
 ===Example===
-<u>http://www.opencellid.org/measure/delete?key=xxx&id=123abc4567890123abcd1234</u>
+<u>https://www.opencellid.org/measure/delete?key=xxx&id=123abc4567890123abcd1234</u>
 ===Availability===
@@ Line 1,740: / Line 1,740: @@
 GET request to
 <pre>
-http://<WebServiceURL>/measure/list
+https://<WebServiceURL>/measure/list
 </pre>
@@ Line 1,983: / Line 1,983: @@
 ===Example===
-<u>http://www.opencellid.org/measure/list?key=xxx&limit=2&offset=128&format=xml</u>
+<u>https://www.opencellid.org/measure/list?key=xxx&limit=2&offset=128&format=xml</u>
 ===Availability===
@@ Line 1,994: / Line 1,994: @@
 GET/POST request to
 <pre>
-http://<WebServiceURL>/measure/listSize
+https://<WebServiceURL>/measure/listSize
 </pre>
@@ Line 2,046: / Line 2,046: @@
 ===Example===
-<u>http://www.opencellid.org/measure/listSize?key=xxx</u>
+<u>https://www.opencellid.org/measure/listSize?key=xxx</u>
 ===Availability===
@@ Line 2,055: / Line 2,055: @@
 ==Check the online status of OpenCellID==
 GET/POST request to
-<pre>http://<WebServiceURL>/ocid/status</pre>
+<pre>https://<WebServiceURL>/ocid/status</pre>
 ===Parameters===
@@ Line 2,070: / Line 2,070: @@
 ===Example===
-<u>http://opencellid.org/ocid/status</u>
+<u>https://opencellid.org/ocid/status</u>
 -->

@@ Line 8: / Line 8: @@
 ==API key==
-Most of the API calls require an API key. This API key can be obtained by registering <u>[http://opencellid.org/ here]</u>.<br>
+Most of the API calls require an API key. This API key can be obtained by registering <u>[https://opencellid.org/ here]</u>.<br>
 All uploaded data will be stored along with this API key. This offers many functions, including the deletion of data from users that provide incorrect data.<br>
 It also allows the identification of users that are violating the community server usage policy.
@@ Line 17: / Line 17: @@
 ==WebServiceURL==
-The base URL for the OpenCellID API service. This should be either <code>http://opencellid.org</code> or <code>https://opencellid.org</code>.<br>
+The base URL (<WebServiceURL>) for the OpenCellID API service. This should be either <code>http://opencellid.org</code> or <code>https://opencellid.org</code>.<br>
 '''Note:''' HTTPS is recommended for secure communication.<br>
@@ Line 398: / Line 398: @@
 | title="Error code" | 4
 | title="HTTP code" | 403
-| title="Description " | Your API key must be white listed in order to run this operation. This service is free of charge as long as your application contributes to the OpenCellID project. Should your application meet this requirement, please contact markus@opencellid.org for the authorisation of your API key.<br><br>For further details please visit:<br>http://wiki.opencellid.org/wiki/Commercial_users<br>http://wiki.opencellid.org/wiki/Request_whitelisting<br><br>You can alternatively download the entire database here:<br>http://opencellid.org/downloads/
+| title="Description " | Your API key must be white listed in order to run this operation. This service is free of charge as long as your application contributes to the OpenCellID project. Should your application meet this requirement, please contact markus@opencellid.org for the authorisation of your API key.<br><br>For further details please visit:<br>https://wiki.opencellid.org/wiki/Commercial_users<br>https://wiki.opencellid.org/wiki/Request_whitelisting<br><br>You can alternatively download the database here:<br>https://opencellid.org/downloads/
 |-
 | title="Error code" | 5
@@ Line 410: / Line 410: @@
 | title="Error code" | 7
 | title="HTTP code" | 429
-| title="Description " | Daily limit 1000 requests exceeded for your API key.<br><br>For further details please visit:<br>http://wiki.opencellid.org/wiki/Commercial_users<br><br>You can alternatively download the entire database here:<br>http://opencellid.org/downloads/
+| title="Description " | Daily limit 1000 requests exceeded for your API key.<br><br>For further details please visit:<br>http://wiki.opencellid.org/wiki/Commercial_users<br><br>You can alternatively download the database here:<br>https://opencellid.org/downloads/
 |}
@@ Line 431: / Line 431: @@
 ===Response===
 Upon successful insert, HTTP 200 is returned with the string "Your measurement has been inserted."
 ===Example===
-<u>http://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&rating=10&direction=90&act=GPRS</u><br>
+<u>https://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&rating=10&direction=90&act=GPRS</u><br>
-<u>http://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&rating=10.1&direction=90.3&speed=12.3&act=GPRS&ta=3</u><br>
+<u>https://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&rating=10.1&direction=90.3&speed=12.3&act=GPRS&ta=3</u><br>
-<u>http://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&rating=10.1&direction=90.3&speed=12.3&act=HSPA+&psc=3</u><br>
+<u>https://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&rating=10.1&direction=90.3&speed=12.3&act=HSPA+&psc=3</u><br>
-<u>http://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&rating=10.1&direction=90.3&speed=12.3&act=LTE&pci=3</u><br>
+<u>https://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&rating=10.1&direction=90.3&speed=12.3&act=LTE&pci=3</u><br>
-<u>http://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&tac=11&cellid=12&rating=10.1&direction=90.3&speed=12.3&act=LTE&pci=3</u><br>
+<u>https://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&tac=11&cellid=12&rating=10.1&direction=90.3&speed=12.3&act=LTE&pci=3</u><br>
-<u>http://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&rating=10.1&direction=90.3&speed=12.3&act=1xRTT</u><br>
+<u>https://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&rating=10.1&direction=90.3&speed=12.3&act=1xRTT</u><br>
-<u>http://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&sid=10&nid=11&bid=12&rating=10.1&direction=90.3&speed=12.3&act=1xRTT</u><br>
+<u>https://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&sid=10&nid=11&bid=12&rating=10.1&direction=90.3&speed=12.3&act=1xRTT</u><br>
-<u>http://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&sid=10&nid=11&bid=12&rating=10.1&direction=90.3&speed=12.3&act=eHRPD</u><br>
+<u>https://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&sid=10&nid=11&bid=12&rating=10.1&direction=90.3&speed=12.3&act=eHRPD</u><br>
-<u>http://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&act=GSM&devn=Samsung%20GT-S5830L&txp=-45&tsrf=22</u>
+<u>https://opencellid.org/measure/add?key=xxx&lat=10.11&lon=11.12&mcc=100&mnc=10&lac=11&cellid=12&act=GSM&devn=Samsung%20GT-S5830L&txp=-45&tsrf=22</u>
 ===Time needed for processing newly uploaded measurements===
@@ Line 502: / Line 497: @@
 ===cURL command===
 <syntaxhighlight lang="bash">
-curl -F "key=apiKey" -F "datafile=@/path/to/file/mydata.csv;type=text/plain" http://opencellid.org/measure/uploadCsv
+curl -F "key=apiKey" -F "datafile=@/path/to/file/mydata.csv;type=text/plain" https://opencellid.org/measure/uploadCsv
 </syntaxhighlight>
@@ Line 529: / Line 524: @@
 This means that the user must send his data (apiKey and csv file) in the same way as from the following form:<br>
 <syntaxhighlight lang="html5">
-<form method="post" action="http://opencellid.org/measure/uploadCsv" enctype="multipart/form-data">
+<form method="post" action="https://opencellid.org/measure/uploadCsv" enctype="multipart/form-data">
    apiKey: <input type="text" name="key" />
    CSV (max 2MB): <input type="file" name="datafile" />
@@ Line 657: / Line 652: @@
 ===cURL command===
 <syntaxhighlight lang="bash">
-curl -F "key=apiKey" -F "datafile=@/path/to/file/mydata.json;type=text/plain" http://opencellid.org/measure/uploadJson
+curl -F "key=apiKey" -F "datafile=@/path/to/file/mydata.json;type=text/plain" https://opencellid.org/measure/uploadJson
 </syntaxhighlight>
@@ Line 694: / Line 689: @@
 This means that the user must send his data (apiKey and json file) in the same way as from the following form:<br>
 <syntaxhighlight lang="html5">
-<form method="post" action="http://opencellid.org/measure/uploadJson" enctype="multipart/form-data">
+<form method="post" action="https://opencellid.org/measure/uploadJson" enctype="multipart/form-data">
    apiKey: <input type="text" name="key" />
    JSON (max 2MB): <input type="file" name="datafile" />
@@ Line 992: / Line 987: @@
 ===Example===
-<u>http://opencellid.org/cell/get?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511</u><br>
+<u>https://opencellid.org/cell/get?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511</u><br>
-<u>http://opencellid.org/cell/get?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&radio=UMTS</u><br>
+<u>https://opencellid.org/cell/get?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&radio=UMTS</u><br>
-<u>http://opencellid.org/cell/get?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&format=json</u>
+<u>https://opencellid.org/cell/get?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&format=json</u>
 ===Availability===

@@ Line 13: / Line 13: @@
 Some smartphone apps also require an API key, for example the <u>[https://play.google.com/store/apps/details?id=info.zamojski.soft.towercollector Tower Collector]</u>.
 In the examples below "apiKey" is used as a place holder for this parameter.
 =="changeable" attribute==