You are looking at the HTML representation of the XML format.
HTML is good for debugging, but is unsuitable for application use.
Specify the format parameter to change the output format.
To see the non HTML representation of the XML format, set format=xml.
See the complete documentation, or
API help for more information.
<?xml version="1.0"?>
<api>
<query>
<pages>
<page pageid="5" ns="0" title="API">
<revisions>
<rev user="Admin" timestamp="2024-10-25T03:49:21Z" comment="https links" contentformat="text/x-wiki" contentmodel="wikitext" xml:space="preserve">{|align=right
|__TOC__
|}
<div style="font-size: 180%;"><span style="color:#505D89">'''API'''</span></div><br>
This wiki page describes all available API functions.<br>
Please contact <u>[mailto:[email protected] Unwired Labs]</u> if you have any suggestions for improvement or bugs to report.
==API key==
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.
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.
==WebServiceURL==
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>
=="changeable" attribute==
The meaning of the "changeable" value returned by some methods is the following:<br>
*some cell positions in the database are precise; for example, the GSM network provider O2 in Germany provides GPS information along with the Cell ID information and software is able to extract this information for OpenCellID.<br>
*in this case, new measurements for the cell are stored and shown on the map; however, their GPS positions are not used for calculating the GPS position of the cell tower.
changeable=1:<br>
the GPS position of the cell tower has been calculated from all available measurements
changeable=0:<br>
the GPS position of the cell tower is precise; no measurements have been used to calculate it.
==Filtering of data==
The following filters are currently applied to all incoming data and decide if a measurement is suspicious or valid.<br>
Suspect data is inserted into a database table with suspect data which can be re-examined at a later stage if required.
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Parameter
! scope="col" | Rules
|-
| title=Parameter | act
| tilte="Rules" | must be one of supported type:<br>1xRTT, CDMA, eHRPD, IS95A, IS95B, EVDO_0, EVDO_A, EVDO_B, UMTS, HSPA+, HSDPA, HSUPA, HSPA, LTE, LTECATM, NR, NBIOT, EDGE, GPRS, GSM
|-
| title="Parameter" | MCC
| title="Rules" | must be known in the database
|-
| title="Parameter" | MCC
| title="Rules" | must be in the range of 100 to 999
|-
| title="Parameter" | MNC/SID
| title="Rules" | must be known in the database
|-
| title="Parameter" | MNC
| title="Rules" | must be in the range of 0 to 999 for GSM, UMTS, LTE, NR and NBIOT
|-
| title="Parameter" | MNC/SID
| title="Rules" | must be in the range of 0 to 32767 for CDMA
|-
| title="Parameter" | LAC/TAC/NID
| title="Rules" | must be in the range of 1 to 65535 for all radios except NR, 0 to 16777215 for NR.
|-
| title="Parameter" | CID
| title="Rules" | must be in the range of 1 to 65535 for GSM
|-
| title="Parameter" | CID
| title="Rules" | must be in the range of 1 to 268435455 for UMTS and LTE, 1 to 68719476735 for NR
|-
| title="Parameter" | CID/BID
| title="Rules" | must be in the range 1 to 65535 for CDMA
|-
| title="Parameter" | longitude
| title="Rules" | must be float (not integer)
|-
| title="Parameter" | longitude
| title="Rules" | must be in the range: (-180,0) U (0,180)
|-
| title="Parameter" | longitude
| title="Rules" | must be != 0
|-
| title="Parameter" | latitude
| title="Rules" | must be float (not integer)
|-
| title="Parameter" | latitude
| title="Rules" | must be in the range: (-90,0) U (0,90)
|-
| title="Parameter" | latitude
| title="Rules" | must be != 0
|}
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Parameters
! scope="col" | Rules
|-
| title=Parameter | MCC,MNC,LAC,CID,longitude,latitude
| tilte="Rules" | must have unique coordinates for the cell
|-
| title="Parameter" | MCC,longitude,latitude
| title="Rules" | must have coordinates in the home country
|-
| title="Parameter" | MCC,MNC,LAC,CID,longitude,latitude
| title="Rules" | must be closer than 150 km away from the cell (only in case of precise cells)
|}
The following filters are currently applied to optional fields in all incoming data.<br>
If an optional field has invalid value, then only the value is rejected.
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Parameter
! scope="col" | Rules
|-
| title=Parameter | measured_at
| tilte="Rules" | must be in one of supported date formats:<br>- timestamp (milliseconds since 1/1/1970 00:00:00 GMT),<br>- "yyyy-MM-dd HH:mm:ss",<br>- "yyyyMMddHHmmss",<br>- "yyyy-MM-dd HH:mm:ss.SSSZ",<br>- "yyyy-MM-dd"
|-
| title="Parameter" | signal
| title="Rules" |
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Technology
! scope="col" | Rules
|-
| title="Technology" | GSM
| title="Rules" | RSSI in dBm in the range of -51 to -113 or ASU in the range of 0 to 31
|-
| title="Technology" | UMTS
| title="Rules" | RSCP in dBm in the range of -25 to -121 or ASU in the range of -5 to 91
|-
| title="Technology" | LTE
| title="Rules" | RSRP in dBm in the range of -45 to -137 or ASU in the range of 0 to 95
|-
| title="Technology" | NR
| title="Rules" | RSRP in dBm in the range of -44 to -140 or ASU in the range of 0 to 97
|-
| title="Technology" | CDMA
| title="Rules" | RSSI in dBm in the range of -75 to -100 or ASU in the range of 1 to 16
|}
|-
| title="Parameter" | rating
| title="Rules" | must be in metres in the range of 0 to 35000
|-
| title="Parameter" | speed
| title="Rules" | must be in metres/second in the range of 0 to 300
|-
| title="Parameter" | direction
| title="Rules" | must be in the range of 0 to 360
|-
| title="Parameter" | ta
| title="Rules" | only for GSM and LTE; must be in the range of 0 to 63
|-
| title="Parameter" | psc
| title="Rules" | only for UMTS; must be in the range of 0 to 511
|-
| title="Parameter" | pci
| title="Rules" | only for LTE; must be in the range of 0 to 503
|-
| title="Parameter" | txp
| title="Rules" | must be in the range of -200 to 100
|-
| title="Parameter" | tsrf
| title="Rules" | must be in the range of -100 to 100
|}
==Payload legend==
A typical payload for API requests and Measurement submissions may include some or all of the following parameters:
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Parameter
! scope="col" | Data type
! scope="col" | Description
! scope="col" | Optional
|-
| title="Parameter" | <apiKey>
| title="Data type" | string
| title="Description" | API key assigned to the user submitting the measurement
| title="Optional" | no
|-
| title="Parameter" | <lat>
| title="Data type" | double
| title="Description" | Latitude
| title="Optional" | no
|-
| title="Parameter" | <lon>
| title="Data type" | double
| title="Description" | Longitude
| title="Optional" | no
|-
| title="Parameter" | <mcc>
| title="Data type" | integer
| title="Description" | Mobile country code
| title="Optional" | no<br>(except CDMA)
|-
| title="Parameter" | <mnc>
| title="Data type" | integer
| title="Description" | Mobile network code or system identifier
| title="Optional" | no<br>(except CDMA if sid is provided)
|-
| title="Parameter" | <lac>
| title="Data type" | integer
| title="Description" | Local area code, tracking area code or network id
| title="Optional" | no<br>(except CDMA if nid is provided or LTE or NR if tac is provided)
|-
| title="Parameter" | <cellid>
| title="Data type" | integer
| title="Description" | Cell tower id or base station id
| title="Optional" | no<br>(except CDMA if bid is provided)
|-
| title="Parameter" | <signal>
| title="Data type" | integer
| title="Description" | Signal level: either in dBm or as defined in TS 27.007 8.5; both is accepted.
| title="Optional" | yes
|-
| title="Parameter" | <measured_at>
| title="Data type" | date
| title="Description" | When the measurement was measured.<br>Supported date formats:<br>- timestamp (milliseconds since 1/1/1970 00:00:00 GMT)<br>- "yyyy-MM-dd HH:mm:ss"<br>- "yyyyMMddHHmmss"<br>- "yyyy-MM-dd HH:mm:ss.SSSZ"<br>- "yyyy-MM-dd"<br>Time zone: UTC
| title="Optional" | yes
|-
| title="Parameter" | <rating>
| title="Data type" | double
| title="Description" | GPS quality/accuracy information (metres)
| title="Optional" | yes
|-
| title="Parameter" | <speed>
| title="Data type" | double
| title="Description" | Speed when creating the measurement, in metres/second
| title="Optional" | yes
|-
| title="Parameter" | <direction>
| title="Data type" | double
| title="Description" | Heading direction when creating the measurement<br>(0=north, 90=east)
| title="Optional" | yes
|-
| title="Parameter" | <act>
| title="Data type" | string
| title="Description" | Network access type; currently supported:<br>1xRTT, CDMA, eHRPD, IS95A, IS95B, EVDO_0, EVDO_A, EVDO_B, UMTS, HSPA+, HSDPA, HSUPA, HSPA, TDSCDMA, LTE, LTECATM, NR, NBIOT, EDGE, GPRS, GSM<br>
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Technology
! scope="col" | Type
! scope="col" | Description
|-
| title="Technology" | CDMA
| title="Type" | 1xRTT
| title="Description" | single-carrier Radio Transmission Technology (2.5G)
|-
| title="Technology" | CDMA
| title="Type" | CDMA (includes IS95A, IS95B)
| title="Description" | Code division multiple access
|-
| title="Technology" | CDMA
| title="Type" | eHRPD
| title="Description" | Enhanced High Rate Packet Data
|-
| title="Technology" | CDMA
| title="Type" | EVDO_0
| title="Description" | Evolution-Data Optimized Revision 0
|-
| title="Technology" | CDMA
| title="Type" | EVDO_A
| title="Description" | Evolution-Data Optimized Revision A
|-
| title="Technology" | CDMA
| title="Type" | EVDO_B
| title="Description" | Evolution-Data Optimized Revision B
|-
| title="Technology" | UMTS
| title="Type" | UMTS
| title="Description" | UMTS access
|-
| title="Technology" | UMTS
| title="Type" | HSPA+
| title="Description" | High speed Packet Access
|-
| title="Technology" | UMTS
| title="Type" | HSDPA
| title="Description" | High Speed Downlink Packet Access
|-
| title="Technology" | UMTS
| title="Type" | HSUPA
| title="Description" | High Speed Uplink Packet Access
|-
| title="Technology" | UMTS
| title="Type" | HSPA
| title="Description" | = "HSDPA/HSUPA" = High Speed Packet Access (both downlink and uplink)
|-
| title="Technology" | UMTS
| title="Type" | TDSCDMA
| title="Description" | = "TDSCDMA" = Time Division Synchronous Code Division Multiple Access (TD-SCDMA)
|-
| title="Technology" | LTE
| title="Type" | LTE
| title="Description" | Long term evolution
|-
| title="Technology" | LTE
| title="Type" | LTECATM
| title="Description" | Long term evolution CAT-M network
|-
| title="Technology" | NR
| title="Type" | NR
| title="Description" | New Radio (5G)
|-
| title="Technology" | NBIOT
| title="Type" | NBIOT
| title="Description" | Narrowband IoT
|-
| title="Technology" | iDEN
| title="Type" | iDEN
| title="Description" | Integrated Digital Enhanced Network
|-
| title="Technology" | GSM
| title="Type" | EDGE
| title="Description" | Enhanced Data Rates for GSM Evolution
|-
| title="Technology" | GSM
| title="Type" | GPRS
| title="Description" | GPRS access
|}
| title="Optional" | yes
|-
| title="Parameter" | <ta>
| title="Data type" | integer
| title="Description" | Timing advance; only for GSM and LTE
| title="Optional" | yes
|-
| title="Parameter" | <psc>
| title="Data type" | integer
| title="Description" | Primary scrambling code; only for UMTS and TDSCDMA
| title="Optional" | yes
|-
| title="Parameter" | <tac>
| title="Data type" | integer
| title="Description" | Tracking area code; only for LTE or NR
| title="Optional" | yes
|-
| title="Parameter" | <pci>
| title="Data type" | integer
| title="Description" | Physical cell Id; only for LTE or NR
| title="Optional" | yes
|-
| title="Parameter" | <sid>
| title="Data type" | integer
| title="Description" | System identifier; only for CDMA
| title="Optional" | yes
|-
| title="Parameter" | <nid>
| title="Data type" | integer
| title="Description" | Network id; only for CDMA
| title="Optional" | yes
|-
| title="Parameter" | <bid>
| title="Data type" | integer
| title="Description" | Base station id; only for CDMA
| title="Optional" | yes
|-
| title="Parameter" | <devn>
| title="Data type" | string
| title="Description" | Device name as concatenated strings with the manufacturer and the model name; max 50 characters
| title="Optional" | yes
|-
| title="Parameter" | <txp>
| title="Data type" | integer
| title="Description" | TX power in dBm
| title="Optional" | yes
|-
| title="Parameter" | <tsrf>
| title="Data type" | integer
| title="Description" | Temperature in the RF module; in degrees Celsius; only with <txp> parameter
| title="Optional" | yes
|}
==Error codes==
The following error codes might be returned by OpenCellID services:
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Error code
! scope="col" | HTTP code
! scope="col" | Description
|-
| title="Error code" | 1
| title="HTTP code" | 200
| title="Description " | Cell not found
|-
| title="Error code" | 2
| title="HTTP code" | 401
| title="Description " | Invalid API key
|-
| title="Error code" | 3
| title="HTTP code" | 400
| title="Description " | Invalid input data
|-
| 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 [email protected] 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
| title="HTTP code" | 500
| title="Description " | Internal server error
|-
| title="Error code" | 6
| title="HTTP code" | 503
| title="Description " | Too many requests. Try later again.
|-
| 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>https://wiki.opencellid.org/wiki/Commercial_users<br><br>You can alternatively download the database here:<br>https://opencellid.org/downloads/
|}
==Adding a single measurement==
GET/POST request to
<pre>
https://<WebServiceURL>/measure/add
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Payload===
key=<apiKey>&lat=<lat>&lon=<lon>&mcc=<mcc>&mnc=<mnc>&lac=<lac>&cellid=<cellid>&signal=<signal>&measured_at=<measured_at>&rating=<rating>&speed=<speed>&direction=<direction>&act=<act>&ta=<ta>&psc=<psc>&tac=<tac>&pci=<pci>&sid=<sid>&nid=<nid>&bid=<bid>&devn=<devn>&txp=<txp>&tsrf=<tsrf>
Where
===Response===
Upon successful insert, HTTP 200 is returned with the string "Your measurement has been inserted."
===Example===
<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>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>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>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>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>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>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>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>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===
After uploading new measurements to the OpenCellID community servers they are added to our waiting queues and processed in the background.
We aim the real-time processing, but maximum time depends on traffic on OpenCellID servers. Current throughput of our servers is around 15000 measurements per second.
Measurements are processed in 3 steps:
# parsing and filtering raw data
# updating measurement statistics and storing measurements in the database
# updating existing cell towers information or adding new cell towers to the database
Our waiting queues for cell towers and for measurements are independent, so you can see your measurements in the OpenCellID database but related cell towers might be not updated yet. This means that if you upload a measurement of a cell tower that was not in the database before and the waiting queue for cell towers has some data to process, you have to expect some times (usually few minutes) until the queue delivers the newly uploaded cell tower information.
==Uploading measurements from a CSV file==
POST request to
<pre>
https://<WebServiceURL>/measure/uploadCsv
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Payload===
CSV file of the following format:
<pre>
mcc,mnc,lac,cellid,lon,lat,signal,measured_at,rating,speed,direction,act,ta,psc,tac,pci,sid,nid,bid
100,2,434,9200,9.436598,52.892139,4,1389472208000,5.4,0,0,GPRS,3,,,,,,
100,2,434,9200,9.441658,52.890351,4,1389472225000,20.1,10.4,90.1,HSPA+,,4,,,,,
100,2,434,9200,9.441658,52.890351,4,1389472225000,20.1,10.4,90.1,LTE,,,,4,,,
100,2,,9200,9.441658,52.890351,4,1389472225000,20.1,10.4,90.1,LTE,,,434,4,,,
100,2,432,9200,9.441658,52.890351,4,1389472225000,20.1,10.4,90.1,LTE,,,432,4,,,
100,1234,432,9201,9.441658,52.890351,4,1389472225000,20.1,10.4,90.1,eHRPD,,,,,,,
100,1234,432,9201,9.441658,52.890351,4,1389472225000,20.1,10.4,90.1,eHRPD,,,,,1234,432,9201
100,,,,9.441658,52.890351,4,1389472225000,20.1,10.4,90.1,1xRTT,,,,,1234,432,9201
,,,,9.441658,52.890351,4,1389472225000,20.1,10.4,90.1,eHRPD,,,,,1234,432,9201
...
</pre>
Column names recognised:<br>
mcc, mnc, lac, cellid, lat, lon, signal, measured_at, rating, speed, direction, act, ta, psc, tac, pci, sid, nid, bid
Maximum file size:<br>
2 MB; upload multiple files if you want to upload more data.
Supplemented by the parameter ''key=<apiKey>'' as form POST field, which is the user's API key.
===Response===
Upon successful insert, HTTP 200 is returned with the string "0,OK".
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.measure.NewMeasureController.
===cURL command===
<syntaxhighlight lang="bash">
curl -F "key=apiKey" -F "datafile=@/path/to/file/mydata.csv;type=text/plain" https://opencellid.org/measure/uploadCsv
</syntaxhighlight>
===Time needed for processing newly uploaded measurements===
After uploading new measurements to the OpenCellID community servers they are added to our waiting queues and processed in the background.
We aim the real-time processing, but maximum time depends on traffic on OpenCellID servers. Current throughput of our servers is around 15000 measurements per second.
Measurements are processed in 3 steps:
# parsing and filtering raw data
# updating measurement statistics and storing measurements in the database
# updating existing cell towers information or adding new cell towers to the database
Our waiting queues for cell towers and for measurements are independent, so you can see your measurements in the OpenCellID database but related cell towers might be not updated yet. This means that if you upload a measurement of a cell tower that was not in the database before and the waiting queue for cell towers has some data to process, you have to expect some times (usually few minutes) until the queue delivers the newly uploaded cell tower information.
===FAQ===
<b>What does "optional" mean?</b><br>
"optional" means that this field is not required in the csv file.<br>
Minimal csv file looks as follows:<br>
<pre>
mcc,mnc,lac,cellid,lon,lat
262,2,434,9200,9.436598,52.892139
</pre>
<b>What does "Supplemented by the parameter key=<apiKey> as form POST field, which is the user's API key" mean?</b><br>
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="https://opencellid.org/measure/uploadCsv" enctype="multipart/form-data">
apiKey: <input type="text" name="key" />
CSV (max 2MB): <input type="file" name="datafile" />
<input type="submit" name="upload" value="Upload"/>
</form>
</syntaxhighlight>
<b>What does the following error mean?</b><br>
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="fail"><err info="cell not found" code="1"/></rsp>
</syntaxhighlight>
This error message means that no cell was found for the given user criteria (mcc-mnc-lac-cid combination was not found in database).
<b>Can I upload CDMA using mcc-mnc-lac-cellid parameters?</b><br>
Yes, you can use mnc as sid, lac as nid and cellid as bid.
==Uploading measurements from a JSON file==
POST request to
<pre>
https://<WebServiceURL>/measure/uploadJson
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Payload===
JSON file (send in ''datafile'' parameter) of the following format:
<syntaxhighlight lang="javascript">
{
"measurements": [
{
"lon": 9.436598,
"lat": 52.892139,
"mcc": 100,
"mnc": 2,
"lac": 434,
"cellid": 9200,
"measured_at": 1389472224000,
"signal": -80,
"rating": 5.4,
"speed": 2.32,
"direction": 93.22,
"act": "EDGE",
"ta": 3
},
{
"lon": 9.441658,
"lat": 52.890351,
"mcc": 100,
"mnc": 2,
"lac": 3,
"cellid": 9200,
"measured_at": 1389472225000,
"signal": -80,
"speed": 11.21,
"act": "HSDPA",
"psc": 2
},
{
"lon": 9.441658,
"lat": 52.890351,
"mcc": 100,
"mnc": 2,
"lac": 321,
"cellid": 9200,
"measured_at": 1389472226000,
"signal": -80,
"rating": 11.21,
"act": "LTE",
"pci": 2
},
{
"lon": 9.441658,
"lat": 52.890351,
"mcc": 100,
"mnc": 2,
"tac": 321,
"cellid": 9200,
"measured_at": 1389472227000,
"signal": -80,
"act": "LTE"
},
{
"lon": 9.441658,
"lat": 52.890351,
"mcc": 100,
"mnc": 12345,
"lac": 1,
"cellid": 2,
"measured_at": 1389472228000,
"signal": -80,
"act": "eHRPD"
},
{
"lon": 9.441658,
"lat": 52.890351,
"mcc": 100,
"sid": 12345,
"nid": 1,
"bid": 2,
"measured_at": 1389472229000,
"signal": -80,
"act": "EVDO_0"
}
]
}
</syntaxhighlight>
Field names recognised:<br>
mcc, mnc, lac, cellid, lat, lon, signal, measured_at, rating, speed, direction, act, ta, psc, tac, pci, sid, nid, bid
Maximum file size:<br>
2 MB; upload multiple files if you want to upload more data.
Supplemented by the parameter ''key=<apiKey>'' as form POST field, which is the user's API key.
===Response===
Upon successful insert, HTTP 200 is returned with ''application/json'' content type and following json document as a content: ''{"code":0,"status":"OK"}''
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.measure.NewMeasureController.
===cURL command===
<syntaxhighlight lang="bash">
curl -F "key=apiKey" -F "datafile=@/path/to/file/mydata.json;type=text/plain" https://opencellid.org/measure/uploadJson
</syntaxhighlight>
===Time needed for processing newly uploaded measurements===
After uploading new measurements to the OpenCellID community servers they are added to our waiting queues and processed in the background.
We aim the real-time processing, but maximum time depends on traffic on OpenCellID servers. Current throughput of our servers is around 15000 measurements per second.
Measurements are processed in 3 steps:
# parsing and filtering raw data
# updating measurement statistics and storing measurements in the database
# updating existing cell towers information or adding new cell towers to the database
Our waiting queues for cell towers and for measurements are independent, so you can see your measurements in the OpenCellID database but related cell towers might be not updated yet. This means that if you upload a measurement of a cell tower that was not in the database before and the waiting queue for cell towers has some data to process, you have to expect some times (usually few minutes) until the queue delivers the newly uploaded cell tower information.
===FAQ===
<b>What does "optional" mean?</b><br>
"optional" means that this field is not required in the json file.<br>
Minimal json file looks as follows:<br>
<syntaxhighlight lang="javascript">
{
"measurements": [
{
"lon": 9.436598,
"lat": 52.892139,
"mcc": 262,
"mnc": 2,
"lac": 434,
"cellid": 9200
}
]
}
</syntaxhighlight>
<b>What does "Supplemented by the parameter key=<apiKey> as form POST field, which is the user's API key" mean?</b><br>
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="https://opencellid.org/measure/uploadJson" enctype="multipart/form-data">
apiKey: <input type="text" name="key" />
JSON (max 2MB): <input type="file" name="datafile" />
<input type="submit" name="upload" value="Upload"/>
</form>
</syntaxhighlight>
<b>What does the following error mean?</b><br>
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="fail"><err info="cell not found" code="1"/></rsp>
</syntaxhighlight>
This error message means that no cell was found for the given user criteria (mcc-mnc-lac-cid combination was not found in database).
<b>Can I upload CDMA using mcc-mnc-lac-cellid parameters?</b><br>
Yes, you can use mnc as sid, lac as nid and cellid as bid.
==Uploading measurements from CLF3 file==
POST request to
<pre>
https://<WebServiceURL>/measure/uploadClf
</pre>
===Parameters===
<WebServiceURL>: The URL to the web service
===Payload===
CLF version 3.0 file (to be sent in datafile parameter) of the following format:
<pre>
//mcc+mnc;cellid;lac;rnc;lat;lon;ratio;data;rfu
26202;07812;03101;0;45.894375;31.51312;0;City Square;0
</pre>
Columns are semicolon separated and have the following strict order:<br>
mcc+mnc, lac, cellid, rnc, lat, lon, ratio, data, rfu
There is no header in CLF3 files.
Therefore the columns must be provided in the order given above and all values must be there.<br>
You can add comments to CLF3 files.<br>
Comments in CLF3 start with // and extend to the end of the physical line.
Maximum file size:<br>
2 MB; upload multiple files if you want to upload more data.
Supplemented by the parameter key=<apiKey> as form POST field, which is the user's API key
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
Supported columns:
! scope="col" | Column name
! scope="col" | Data type
! scope="col" | Description
! scope="col" | Optional
|-
| title="Column name" | <mcc+mnc>
| title="Data type" | string
| title="Description" | Mobile country code and mobile network code
| title="Optional" | no
|-
| title="Column name" | lac
| title="Data type" | integer
| title="Description" | Local area code
| title="Optional" | no
|-
| title="Column name" | cellid
| title="Data type" | integer
| title="Description" | Cell tower id
| title="Optional" | no
|-
| title="Column name" | rnc
| title="Data type" | integer
| title="Description" | Radio network controller;<br>provide "0", (zero, without the quotation marks) or an empty string in case there is no rnc value.
| title="Optional" | no
|-
| title="Column name" | lat
| title="Data type" | double
| title="Description" | Latitude
| title="Optional" | no
|-
| title="Column name" | lon
| title="Data type" | double
| title="Description" | Latitude
| title="Optional" | no
|-
| title="Column name" | ratio
| title="Data type" | integer
| title="Description" | Accuracy of the cell coordinates. Use -1 for the exact position.
| title="Optional" | yes
|-
| title="Column name" | data
| title="Data type" | string
| title="Description" | Short cell description
| title="Optional" | yes
|-
| title="Column name" | rfu
| title="Data type" | string
| title="Description" | Not really used; use 0 if unknown
| title="Optional" | yes
|}
===Response===
On successful insert return HTTP 200 with the string "0,OK".
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.measure.NewMeasureController.
===Time needed for processing newly uploaded measurements===
After uploading new measurements to the OpenCellID community servers they are added to our waiting queues and processed in the background.
We aim the real-time processing, but maximum time depends on traffic on OpenCellID servers. Current throughput of our servers is around 15000 measurements per second.
Measurements are processed in 3 steps:
# parsing and filtering raw data
# updating measurement statistics and storing measurements in the database
# updating existing cell towers information or adding new cell towers to the database
Our waiting queues for cell towers and for measurements are independent, so you can see your measurements in the OpenCellID database but related cell towers might be not updated yet. This means that if you upload a measurement of a cell tower that was not in the database before and the waiting queue for cell towers has some data to process, you have to expect some times (usually few minutes) until the queue delivers the newly uploaded cell tower information.
==Getting cell position==
GET/POST request to
<pre>
https://<WebServiceURL>/cell/get
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Headers===
'''JSON:'''<br>Content-Type: application/json;charset=UTF-8
'''XML:'''<br>Content-Type: text/xml;charset=utf-8
'''AT:'''<br>Content-Type: text/plain;charset=utf-8
===Payload===
key=<apiKey>&mcc=<mcc>&mnc=<mnc>&lac=<lac>&cellid=<cellid>&radio=<radio>&format=<format>
Where
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Parameter
! scope="col" | Data type
! scope="col" | Description
! scope="col" | Optional
|-
| title="Parameter" | <apiKey>
| title="Data type" | string
| title="Description" | API key assigned to the user
| title="Optional" | no
|-
| title="Parameter" | <mcc>
| title="Data type" | integer
| title="Description" | Mobile country code
| title="Optional" | no
|-
| title="Parameter" | <mnc>
| title="Data type" | integer
| title="Description" | Mobile network code or system identifier
| title="Optional" | no
|-
| title="Parameter" | <lac>
| title="Data type" | integer
| title="Description" | Local area code, tracking area code or network id
| title="Optional" | no
|-
| title="Parameter" | <cellid>
| title="Data type" | integer
| title="Description" | Cell id or base station id
| title="Optional" | no
|-
| title="Parameter" | <radio>
| title="Data type" | string
| title="Description" | You can specifiy GSM, UMTS, LTE, NBIOT, NR or CDMA as the radio of returned cell. Otherwise first matched cell will be returned.
| title="Optional" | yes
|-
| title="Parameter" | <format>
| title="Data type" | string
| title="Description" | You can specifiy xml, at or json as output. Default is xml.
| title="Optional" | yes
|}
===Response===
====XML====
Upon successful request, HTTP 200 is returned with XML of the following format:
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<cell lat="52.891587"
lon="9.438145"
mcc="262"
mnc="2"
lac="434"
cellid="9200"
averageSignalStrength="-81"
range="123"
samples="13"
changeable="1"
radio="GSM"/>
</rsp>
</syntaxhighlight>
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<cell lat="51.206"
lon="20.424"
mcc="260"
mnc="2"
lac="52712"
cellid="59350690"
averageSignalStrength="-96"
range="1234"
samples="5"
changeable="1"
radio="UMTS"
rnc="905"
cid="40610"/>
</rsp>
</syntaxhighlight>
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<cell lat="51.90994"
lon="19.505"
mcc="260"
mnc="6"
lac="12"
cellid="864246"
averageSignalStrength="-100"
range="12345"
samples="4"
changeable="1"
radio="LTE"
tac="12"/>
</rsp>
</syntaxhighlight>
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<cell lat="42.46"
lon="-73.245"
mcc="310"
mnc="119"
lac="48"
cellid="4127"
averageSignalStrength="-90"
range="123"
samples="5"
changeable="1"
radio="CDMA"
sid="119"
nid="48"
bid="4127"/>
</rsp>
</syntaxhighlight>
====JSON====
<syntaxhighlight lang="javascript">
{
"lon": -73.245,
"lat": 42.46,
"mcc": 310,
"mnc": 119,
"lac": 48,
"cellid": 4127,
"averageSignalStrength": -90,
"range": 123,
"samples": 5,
"changeable": true,
"radio": "CDMA",
"sid": 119,
"nid": 48,
"bid": 4127
}
</syntaxhighlight>
====AT====
<syntaxhighlight lang="text">
+Location:42.46,-73.245,1483228800
</syntaxhighlight>
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.cell.CellController.<br>
It uses de.enaikoon.m2m.gsmcellmanagment.dao.mongodb.GsmCellDao to calculate the average cell measurement, and builds an XML string to return to the user.
===Example===
<u>https://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&radio=UMTS</u><br>
<u>https://opencellid.org/cell/get?key=xxx&mcc=260&mnc=2&lac=10250&cellid=26511&format=json</u>
===Availability===
This feature is available free of charge in case your application contributes data to OpenCellID at the same time.<br>
In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
An automated check for providing this service to white-listed apiKeys only was activated on Jun 15th, 2014
<!--
==Getting the raw measurements used to compute the position of a cell==
GET/POST request to
<pre>
https://<WebServiceURL>/cell/getMeasures
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Payload===
key=<apiKey>&mcc=<mcc>&mnc=<mnc>&lac=<lac>&cellid=<cellid>&radio=<radio>&limit=<limit>&offset=<offset>&format=<format>
Where
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Parameter
! scope="col" | Data type
! scope="col" | Description
! scope="col" | Optional
|-
| title="Parameter" | <apiKey>
| title="Data type" | string
| title="Description" | API key assigned to the user
| title="Optional" | no
|-
| title="Parameter" | <mcc>
| title="Data type" | integer
| title="Description" | Mobile country code
| title="Optional" | no
|-
| title="Parameter" | <mnc>
| title="Data type" | integer
| title="Description" | Mobile network code or system identifier
| title="Optional" | no
|-
| title="Parameter" | <lac>
| title="Data type" | integer
| title="Description" | Local area code, tracking area code or network id
| title="Optional" | no
|-
| title="Parameter" | <cellid>
| title="Data type" | integer
| title="Description" | Cell id or base station id
| title="Optional" | no
|-
| title="Parameter" | <radio>
| title="Data type" | string
| title="Description" | You can specifiy GSM, UMTS, LTE, NR, NBIOT or CDMA as the radio of returned data. Otherwise first matched cell will be returned with its measurements.
| title="Optional" | yes
|-
| title="Parameter" | <limit>
| title="Data type" | integer
| title="Description" | A number defining max size of the returned list.<br>Default and max value is 1000.
| title="Optional" | yes
|-
| title="Parameter" | <offset>
| title="Data type" | integer
| title="Description" | The field says to skip that many measurements before beginning to return measurements.<br>Default is 0.
| title="Optional" | yes
|-
| title="Parameter" | <format>
| title="Data type" | string
| title="Description" | You can specifiy xml or json as output. Default is xml.
| title="Optional" | yes
|}
For the total number of measurements used to compute the position of a cell, please use /cell/getMeasuresSize (described below).
===Response===
====XML====
Upon successful request, HTTP 200 is returned with XML in the following format:<br>
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<cell lat="42.47"
lon="-73.24"
mcc="310"
mnc="119"
lac="48"
cellid="4217"
averageSignalStrength="-91"
range="123"
samples="2"
changeable="1"
radio="CDMA"
sid="119"
nid="48"
bid="4217">
<measure id="53cfd12ee4b033313ec44a01"
lat="42.469"
lon="-73.24"
mcc="310"
mnc="119"
lac="48"
cellid="4217"
created_at="1400128406300"
measured_at="1400127406300"
signal="-90"
rating="10.1"
speed="20.2"
direction="30.0"
radio="CDMA"
sid="119"
nid="48"
bid="4217"/>
<measure id="53cfd177e4b033313ec44e51"
lat="42.471"
lon="-73.24"
mcc="310"
mnc="119"
lac="48"
cellid="4217"
created_at="1400128493848"
measured_at="1400127493848"
signal="-92"
rating="20.0"
speed="40.0"
direction="40.0"
radio="CDMA"
sid="119"
nid="48"
bid="4217"/>
</cell>
</rsp>
</syntaxhighlight>
====JSON====
<syntaxhighlight lang="javascript">
{
"cell": {
"lon": 20.42,
"lat": 51.2,
"mcc": 260,
"mnc": 2,
"lac": 52702,
"cellid": 59350690,
"averageSignalStrength": -90,
"range": 123,
"samples": 2,
"changeable": true,
"radio": "UMTS",
"rnc": 905,
"cid": 40610
},
"measurements": [
{
"id": "52d3db7ccd214d12357b9fee",
"lon": 20.42,
"lat": 51.2,
"mcc": 260,
"mnc": 2,
"lac": 52702,
"cellid": 59350690,
"created_at": 1399614776134,
"measured_at": 1398477214000,
"signal": -90,
"rating": 10.1,
"speed": 20.4,
"direction": 90.8,
"radio": "UMTS",
"rnc": 905,
"cid": 40610
},
{
"id": "52d3db7ccd214d12357b9ff2",
"lon": 20.42,
"lat": 51.2,
"mcc": 260,
"mnc": 2,
"lac": 52702,
"cellid": 59350690,
"created_at": 1380559325000,
"measured_at": 1379477219000,
"signal": -90,
"radio": "UMTS",
"rnc": 905,
"cid": 40610,
"psc": 2
}
]
}
</syntaxhighlight>
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.measure.CellController.
===Example===
<u>https://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&radio=UMTS&limit=10&offset=1&format=json</u>
===Availability===
This feature is available free of charge in case your application contributes data to OpenCellID at the same time.<br>
In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
An automated check for providing this service to white-listed apiKeys only was activated on Jun 15th, 2014
==Getting the number of all measures used to compute the position of a cell==
GET/POST request to
<pre>
https://<WebServiceURL>/cell/getMeasuresSize
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Payload===
key=<apiKey>&mcc=<mcc>&mnc=<mnc>&lac=<lac>&cellid=<cellid>&radio=<radio>&format=<format>
Where
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Parameter
! scope="col" | Data type
! scope="col" | Description
! scope="col" | Optional
|-
| title="Parameter" | <apiKey>
| title="Data type" | string
| title="Description" | API key assigned to the user
| title="Optional" | no
|-
| title="Parameter" | <mcc>
| title="Data type" | integer
| title="Description" | Mobile country code
| title="Optional" | no
|-
| title="Parameter" | <mnc>
| title="Data type" | integer
| title="Description" | Mobile network code or system identifier
| title="Optional" | no
|-
| title="Parameter" | <lac>
| title="Data type" | integer
| title="Description" | Local area code, tracking area code or network id
| title="Optional" | no
|-
| title="Parameter" | <cellid>
| title="Data type" | integer
| title="Description" | Cell id or base station id
| title="Optional" | no
|-
| title="Parameter" | <radio>
| title="Data type" | string
| title="Description" | You can specifiy GSM, UMTS, LTE, NR, NBIOT or CDMA as the radio of returned data. Otherwise first matched cell will be returned with its measurements.
| title="Optional" | yes
|-
| title="Parameter" | <format>
| title="Data type" | string
| title="Description" | You can specifiy xml or json as output. Default is xml.
| title="Optional" | no
|}
===Response===
====XML====
Upon successful request, HTTP 200 is returned with XML in the following format:<br>
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<measurements count="123"/>
</rsp>
</syntaxhighlight>
====JSON====
<syntaxhighlight lang="javascript">
{
"count": 123
}
</syntaxhighlight>
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.measure.CellController.
===Example===
<u>https://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&format=json</u>
===Availability===
This feature is available free of charge in case your application contributes data to OpenCellID at the same time.<br>
In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
An automated check for providing this service to white-listed apiKeys only was activated on Jun 15th, 2014
-->
==Getting the list of cells in a specified area==
GET request to
<pre>
https://<WebServiceURL>/cell/getInArea
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Payload===
key=<apiKey>&BBOX=<latmin>,<lonmin>,<latmax>,<lonmax>&mcc=<mcc>&mnc=<mnc>&lac=<lac>&radio=<radio>&limit=<limit>&offset=<offset>&format=<format>
Where
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Parameter
! scope="col" | Data type
! scope="col" | Description
! scope="col" | Optional
|-
| title="Parameter" | <apiKey>
| title="Data type" | string
| title="Description" | API key assigned to the user
| title="Optional" | no
|-
| title="Parameter" | <latmin>
| title="Data type" | double
| title="Description" | Minimal bounding latitude
| title="Optional" | no
|-
| title="Parameter" | <lonmin>
| title="Data type" | double
| title="Description" | Minimal bounding longitude
| title="Optional" | no
|-
| title="Parameter" | <latmax>
| title="Data type" | double
| title="Description" | Maximal bounding latitude
| title="Optional" | no
|-
| title="Parameter" | <lonmax>
| title="Data type" | double
| title="Description" | Maximal bounding longitude
| title="Optional" | no
|-
| title="Parameter" | <mcc>
| title="Data type" | integer
| title="Description" | Mobile country code; If you want to restrict the result to a specific country
| title="Optional" | yes
|-
| title="Parameter" | <mnc>
| title="Data type" | integer
| title="Description" | Mobile network code or system identifier; If you want to restrict the result
| title="Optional" | yes
|-
| title="Parameter" | <lac>
| 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
|-
| title="Parameter" | <radio>
| title="Data type" | string
| title="Description" | You can specifiy GSM, UMTS, LTE, NR, NBIOT or CDMA as the radio of returned cells. Otherwise cells with any radios will be returned.
| title="Optional" | yes
|-
| title="Parameter" | <limit>
| title="Data type" | integer
| title="Description" | A number defining maximum size of the returned list. Default and maximum value is 1000.
| 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="Optional" | yes
|-
| title="Parameter" | <format>
| title="Data type" | string
| title="Description" | You can specify kml, xml, csv or json as output. Default is kml.<br>In csv type of output, there is a first line defining the content of the list.
| title="Optional" | yes
|}
For the total number of cells in a specified area, please use /cell/getInAreaSize (described below).
===Response===
Upon successful request, HTTP 200 is returned with one of the following output structures:
====XML====
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<cell lat="52.9523755"
lon="9.252112"
mcc="262"
mnc="2"
lac="1434"
cellid="17275"
averageSignalStrength="-70"
range="123"
samples="12"
changeable="1"
radio="GSM"/>
<cell lat="52.9463072"
lon="9.258809"
mcc="262"
mnc="2"
lac="1434"
cellid="17276"
averageSignalStrength="-98"
range="1234"
samples="11"
changeable="1"
radio="LTE"
tac="1434"/>
<cell lat="52.9367185"
lon="9.27343925"
mcc="260"
mnc="16256"
lac="1434"
cellid="17272"
averageSignalStrength="-93"
range="12345"
samples="12"
changeable="1"
radio="CDMA"
sid="16256"
bid="1434"
nid="17272"/>
</rsp>
</syntaxhighlight>
====KML (default)====
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<name>OpenCellID Cells</name>
<description>List of available cells</description>
<Placemark>
<name></name>
<description><![CDATA[lat: <b>52.9523755</b><br/>
lon: <b>9.252112</b><br/>
mcc: <b>262</b><br/>
mnc: <b>2</b><br/>
lac: <b>1434</b><br/>
cellid: <b>17275</b><br/>
averageSignalStrength: <b>-73</b><br/>
range: <b>123</b><br/>
samples: <b>12</b><br/>
changeable: <b>1</b><br/>
radio: <b>GSM</b><br/>
rnc: <b></b><br/>
cid: <b></b><br/>
tac: <b></b><br/>
sid: <b></b><br/>
nid: <b></b><br/>
bid: <b></b>]]>
</description>
<Point><coordinates>9.252112,52.9523755,0</coordinates></Point>
</Placemark>
<Placemark>
<name></name>
<description><![CDATA[lat: <b>52.9463072</b><br/>
lon: <b>21.1525</b><br/>
mcc: <b>260</b><br/>
mnc: <b>2</b><br/>
lac: <b>1434</b><br/>
cellid: <b>17272</b><br/>
averageSignalStrength: <b>-83</b><br/>
range: <b>1234</b><br/>
samples: <b>11</b><br/>
changeable: <b>1</b><br/>
radio: <b>LTE</b><br/>
rnc: <b></b><br/>
cid: <b></b><br/>
tac: <b>1434</b><br/>
sid: <b></b><br/>
nid: <b></b><br/>
bid: <b></b>]]>
</description>
<Point><coordinates>21.1525,52.9463072,0</coordinates></Point>
</Placemark>
<Placemark>
<name></name>
<description><![CDATA[lat: <b>53.9367185</b><br/>
lon: <b>12.27343925</b><br/>
mcc: <b>262</b><br/>
mnc: <b>16256</b><br/>
lac: <b>1434</b><br/>
cellid: <b>17272</b><br/>
averageSignalStrength: <b>-91</b><br/>
range: <b>12345</b><br/>
samples: <b>2</b><br/>
changeable: <b>1</b><br/>
radio: <b>CDMA</b><br/>
rnc: <b></b><br/>
cid: <b></b><br/>
tac: <b></b><br/>
sid: <b>16256</b><br/>
nid: <b>1434</b><br/>
bid: <b>17272</b>]]>
</description>
<Point><coordinates>12.27343925,53.9367185,0</coordinates></Point>
</Placemark>
<Placemark>
<name></name>
<description><![CDATA[lat: <b>52.1322157</b><br/>
lon: <b>21.065345</b><br/>
mcc: <b>260</b><br/>
mnc: <b>2</b><br/>
lac: <b>1434</b><br/>
cellid: <b>42042781</b><br/>
averageSignalStrength: <b>-89</b><br/>
range: <b>1231</b><br/>
samples: <b>5</b><br/>
changeable: <b>1</b><br/>
radio: <b>UMTS</b><br/>
rnc: <b>641</b><br/>
cid: <b>34205</b><br/>
tac: <b></b><br/>
sid: <b></b><br/>
nid: <b></b><br/>
bid: <b></b>]]>
</description>
<Point><coordinates>21.065345,52.1322157,0</coordinates></Point>
</Placemark>
</Document>
</kml>
</syntaxhighlight>
====CSV====
<pre>lat,lon,mcc,mnc,lac,cellid,averageSignalStrength,range,samples,changeable,radio,rnc,cid,tac,sid,nid,bid
52.275505,21.016382,260,2,45080,21728,-55,123,2,1,GSM,,,,,,
52.201454,21.065345,260,2,58140,42042781,-59,1234,3,1,UMTS,641,34205,,,,
52.207123,21.029972,260,6,58,119093,-80,122,2,1,LTE,,,58,,,
52.274612,21.034485,260,16256,45,22613,-98,134,2,1,CDMA,,,,16256,45,22613</pre>
====JSON====
<syntaxhighlight lang="javascript">
{
"count": 3,
"cells": [
{
"lon": 21.014,
"lat": 52.278,
"mcc": 260,
"mnc": 2,
"lac": 45080,
"cellid": 22613,
"averageSignalStrength": -70,
"range": 123,
"samples": 2,
"changeable": true,
"radio": "GSM"
},
{
"lon": 21.04,
"lat": 52.2234,
"mcc": 260,
"mnc": 2,
"lac": 58140,
"cellid": 42042781,
"averageSignalStrength": -90,
"range": 125,
"samples": 2,
"changeable": true,
"radio": "UMTS",
"rnc": 641,
"cid": 34205
},
{
"lon": 21.5604,
"lat": 52.284,
"mcc": 260,
"mnc": 2,
"lac": 581,
"cellid": 42048,
"averageSignalStrength": -90,
"range": 12345,
"samples": 9,
"changeable": true,
"radio": "LTE",
"tac": 581
}
]
}
</syntaxhighlight>
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.measure.CellController.
===Example===
<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>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===
This feature is available free of charge in case your application contributes data to OpenCellID at the same time.<br>
In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
An automated check for providing this service to white-listed apiKeys only was activated on Jun 15th, 2014
==Getting the number of cells in a specified area==
GET request to
<pre>
https://<WebServiceURL>/cell/getInAreaSize
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Payload===
key=<apiKey>&BBOX=<latmin>,<lonmin>,<latmax>,<lonmax>&mcc=<mcc>&mnc=<mnc>&lac=<lac>&radio=<radio>&format=<format>
Where
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" | Parameter
! scope="col" | Data type
! scope="col" | Description
! scope="col" | Optional
|-
| title="Parameter" | <apiKey>
| title="Data type" | string
| title="Description" | API key assigned to the user
| title="Optional" | no
|-
| title="Parameter" | <latmin>
| title="Data type" | double
| title="Description" | Minimal bounding latitude
| title="Optional" | no
|-
| title="Parameter" | <lonmin>
| title="Data type" | double
| title="Description" | Minimal bounding longitude
| title="Optional" | no
|-
| title="Parameter" | <latmax>
| title="Data type" | double
| title="Description" | Maximal bounding latitude
| title="Optional" | no
|-
| title="Parameter" | <lonmax>
| title="Data type" | double
| title="Description" | Maximal bounding longitude
| title="Optional" | no
|-
| title="Parameter" | <mcc>
| title="Data type" | integer
| title="Description" | Mobile country code; If you want to restrict the result to a specific country
| title="Optional" | yes
|-
| title="Parameter" | <mnc>
| title="Data type" | integer
| title="Description" | Mobile network code or system identifier; If you want to restrict the result
| title="Optional" | yes
|-
| title="Parameter" | <lac>
| 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
|-
| title="Parameter" | <radio>
| title="Data type" | string
| title="Description" | You can specifiy GSM, UMTS, LTE, NR or CDMA as the radio of returned data. Otherwise any cells will be returned.
| title="Optional" | yes
|-
| title="Parameter" | <format>
| title="Data type" | string
| title="Description" | You can specifiy xml or json as output. Default is xml.
| title="Optional" | yes
|}
===Response===
Upon successful request, HTTP 200 is returned with XML in the following format:
====XML====
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<cells count="5"/>
</rsp>
</syntaxhighlight>
====JSON====
<syntaxhighlight lang="javascript">
{
"count": 123
}
</syntaxhighlight>
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.measure.CellController.
===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>
===Availability===
This feature is available free of charge in case your application contributes data to OpenCellID at the same time.<br>
In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
An automated check for providing this service to white-listed apiKeys only was activated on Jun 15th, 2014
<!--
==Deleting a measurement==
POST request to
<pre>
https://<WebServiceURL>/measure/delete
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
<id>: ID of the measurement to be deleted
===Payload===
key=<apiKey>&id=<id>
Where
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" class="unsortable" | Parameter
! scope="col" class="unsortable" | Data type
! scope="col" class="unsortable" | Description
| scope="col" class="unsortable" | Optional
|-
| title="Parameter" | <apiKey>
| title="Data type" | string
| title="Description" | API key assigned to the user
| title="Optional" | no
|-
| title="Parameter" | <id>
| title="Data type" | string
| title="Description" | ID of the measure to delete
| title="Optional" | no
|}
===Response===
Upon successful deletion, HTTP 200 is returned with the string "Measurement with id=<id> has been deleted."
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.measure.MeasureController.
===Example===
<u>https://www.opencellid.org/measure/delete?key=xxx&id=123abc4567890123abcd1234</u>
===Availability===
This feature is available free of charge in case your application contributes data to OpenCellID at the same time.<br>
In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
An automated check for providing this service to white-listed apiKeys only was activated on Jun 15th, 2014
==Listing a user's measurements==
GET request to
<pre>
https://<WebServiceURL>/measure/list
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Payload===
key=<apiKey>&limit=<limit>&offset=<offset>&format=<format>
Where
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" class="unsortable" | Parameter
! scope="col" class="unsortable" | Data type
! scope="col" class="unsortable" | Description
! scope="col" class="unsortable" | Optional
|-
| title="Parameter" | <apiKey>
| title="Data type" | string
| title="Description" | API key assigned to the user
| title="Optional" | no
|-
| title="Parameter" | <limit>
| title="Data type" | integer
| title="Description" | A number defining maximum size of the returned list.<br>Default and maximum value is 1000.
| title="Optional" | yes
|-
| title="Parameter" | <offset>
| title="Data type" | integer
| title="Description" | The field says to skip that many measurements before beginning to return measurements.<br>Default is 0.
| title="Optional" | yes
|-
| title="Parameter" | <format>
| title="Data type" | string
| title="Description" | You can specify csv, xml, kml or json as output. Default is csv.<br>In csv type of output, a first line defining the content of the list.
| title="Optional" | yes
|}
For the total number of cells in a specified area, please use /measure/listSize (described below).
===Response===
Upon successful request, HTTP 200 is returned with one of the following output structures, '''oldest''' entries first:
====CSV (default)====
<pre>
id,mcc,mnc,lac,cellid,lat,lon,created_at,measured_at,signal,rating,speed,direction,radio,ta,rnc,cid,psc,tac,pci,sid,nid,bid
127b4c71e4b041a566539fc5,260,2,38,17171,21.0132,52.235,1400589414253,1396096553493,-90,,,,GSM,3,,,,,,,,
14b52ea2e4b564a972d12361,260,6,52712,59350690,20.424,51.206,1404382897375,1404382894835,-70,,,,UMTS,,905,40610,123,,,,,
14b52ea2e4b564a972c73b29,260,6,18512,30694,21.0132,52.21,1404382866577,1404381511123,-60,10.1,2.3,93.1,LTE,,,,,18512,,,,
14b52ea2e4b564a972c82a67,260,6,18512,30694,21.0137,52.212,1404382867773,1404381512374,-60,10.2,2.5,93.2,LTE,2,,,,18512,3,,,
15b52ea2e4b564a972d11114,310,119,48,4127,42.46,-73.245,1404382891235,1404382890121,-99,,,,CDMA,,,,,,,119,48,4127
</pre>
====XML====
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<measure id="1213db7abcda4d36357b9f12"
lat="52.892139"
lon="9.436598"
mcc="262"
mnc="2"
lac="434"
cellid="9200"
created_at="1311615996112"
measured_at="1311512208000"
signal="-94"
rating="10.1"
speed="10.2"
direction="90.9"
radio="GSM"
ta="3" />
<measure id="1213db7abcda4d36357b9f15"
lat="52.212"
lon="21.0137"
mcc="260"
mnc="2"
lac="52712"
cellid="59350690"
created_at="1311615996122"
measured_at="1311511534000"
signal="-83"
rating="20.1"
speed="1.2"
direction="9.5"
radio="UMTS"
rnc="905"
cid="40610"
psc="102" />
<measure id="14b12ca2e4b564a972c82321"
lat="52.96261"
lon="9.241319"
mcc="262"
mnc="2"
lac="1434"
cellid="17271"
created_at="1404382891235"
measured_at="1404382890121"
signal="-82"
rating="20.12"
speed="11.12"
direction="90.5"
radio="LTE"
tac="1434"
pci="2" />
<measure id="15b52ea2e4b564a972d11114"
lat="42.46"
lon="-73.245"
mcc="310"
mnc="119"
lac="48"
cellid="4127"
created_at="1404382897375"
measured_at="1404382897221"
signal="-99"
rating="0.0"
speed="0.0"
direction="0.0"
radio="CDMA"
sid="119"
nid="48"
bid="4127" />
</rsp>
</syntaxhighlight>
====KML====
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://www.opengis.net/kml/2.2">
<Document>
<name>OpenCellID measurements</name>
<description>List of user's measurements</description>
<Placemark>
<name></name>
<description><![CDATA[id: <b>5213db7abcda4d36357b9f12</b><br/>
mcc: <b>262</b><br/>
mnc: <b>2</b><br/>
lac: <b>434</b><br/>
cellid: <b>9200</b><br/>
lat: <b>52.892139</b><br/>
lon: <b>9.436598</b><br/>
created_at: <b>1311615996112</b><br/>
measured_at: <b>1311512208000</b><br/>
signal: <b>4</b><br/>
rating: <b>3.4</b><br/>
speed: <b>0</b><br/>
direction: <b>0</b><br/>
radio: <b>GSM</b><br/>
ta: <b>2</b><br/>
rnc: <b></b><br/>
cid: <b></b><br/>
psc: <b></b><br/>
tac: <b></b><br/>
pci: <b></b><br/>
sid: <b></b><br/>
nid: <b></b><br/>
bid: <b></b>]]>
</description>
<Point><coordinates>9.436598,52.892139,0</coordinates></Point>
</Placemark>
<Placemark>
<name></name>
<description><![CDATA[id: <b>5213db7abcda4d36357b9f15</b><br/>
mcc: <b>262</b><br/>
mnc: <b>2</b><br/>
lac: <b>1434</b><br/>
cellid: <b>59350690</b><br/>
lat: <b>52.96261</b><br/>
lon: <b>9.241319</b><br/>
created_at: <b>1311615996112</b><br/>
measured_at: <b>1311511534000</b><br/>
signal: <b>3</b><br/>
rating: <b>4.4</b><br/>
speed: <b>4.02</b><br/>
direction: <b>0.56</b><br/>
radio: <b>UMTS</b><br/>
ta: <b></b><br/>
rnc: <b>905</b><br/>
cid: <b>40610</b><br/>
psc: <b>12</b><br/>
tac: <b></b><br/>
pci: <b></b><br/>
sid: <b></b><br/>
nid: <b></b><br/>
bid: <b></b>]]>
</description>
<Point><coordinates>9.241319,52.96261,0</coordinates></Point>
</Placemark>
</Document>
</kml>
</syntaxhighlight>
====JSON====
<syntaxhighlight lang="javascript">
{
"count": 2,
"measurements": [
{
"id": "11123b7abcda1436357b9f12",
"lon": 9.436598,
"lat": 52.892139,
"mcc": 262,
"mnc": 2,
"lac": 434,
"cellid": 9200,
"created_at": 1311615996112,
"measured_at": 1311512208000,
"signal": -84,
"rating": 10.3,
"speed": 10.2,
"direction": 90.08,
"radio": "GSM",
"ta": 3
},
{
"id": "11123b7abcda1236357b9f15",
"lon": 9.241319,
"lat": 52.96261,
"mcc": 262,
"mnc": 2,
"lac": 1434,
"cellid": 42119093,
"created_at": 1311615996122,
"measured_at": 1311511534000,
"signal": -93,
"rating": 20.13,
"speed": 11.1,
"direction": 90.01,
"radio": "UMTS",
"rnc": 642,
"cid": 44981
}
]
}
</syntaxhighlight>
If you want the '''newest''' entries, use an <code>&offset=</code> to subtract most of the [[#Getting the number of measurements from a user|number of measurements from a user]].
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.measure.MeasureController.
===Example===
<u>https://www.opencellid.org/measure/list?key=xxx&limit=2&offset=128&format=xml</u>
===Availability===
This feature is available free of charge in case your application contributes data to OpenCellID at the same time.<br>
In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
An automated check for providing this service to white-listed apiKeys only was activated on Jun 15th, 2014
==Getting the number of measurements from a user==
GET/POST request to
<pre>
https://<WebServiceURL>/measure/listSize
</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Payload===
key=<apiKey>&format=<format>
Where
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
|-
! scope="col" class="unsortable" | Parameter
! scope="col" class="unsortable" | Data type
! scope="col" class="unsortable" | Description
! scope="col" class="unsortable" | Optional
|-
| title="Parameter" | <apiKey>
| title="Data type" | string
| title="Description" | API key assigned to the user
| title="Optional" | no
|-
| title="Parameter" | <format>
| title="Data type" | string
| title="Description" | You can specifiy xml or json as output. Default is xml.
| title="Optional" | yes
|}
===Response===
====XML====
Upon successful request, HTTP 200 is returned with XML in the following format:
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<measurements count="123"/>
</rsp>
</syntaxhighlight>
====JSON====
<syntaxhighlight lang="javascript">
{
"count": 5
}
</syntaxhighlight>
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.measure.MeasureController.
===Example===
<u>https://www.opencellid.org/measure/listSize?key=xxx</u>
===Availability===
This feature is available free of charge in case your application contributes data to OpenCellID at the same time.<br>
In case you want to use this service without contributing to OpenCellID please refer to <u>[[Commercial_users|the commercial users guideline]]</u>.<br>
An automated check for providing this service to white-listed apiKeys only was activated on Jun 15th, 2014
==Check the online status of OpenCellID==
GET/POST request to
<pre>https://<WebServiceURL>/ocid/status</pre>
===Parameters===
<WebServiceURL>: the URL to the web service
===Response===
Upon successful request, HTTP 200 is returned with JSON in the following format:
<syntaxhighlight lang="javascript">
{"status":"ok"}
</syntaxhighlight>
===Business logic===
The request is handled by de.enaikoon.gpssuite.web.ocid.StatusController
===Example===
<u>https://opencellid.org/ocid/status</u>
--></rev>
</revisions>
</page>
<page pageid="1" ns="0" title="Main Page">
<revisions>
<rev user="Admin" timestamp="2018-04-25T16:50:45Z" comment="" contentformat="text/x-wiki" contentmodel="wikitext" xml:space="preserve">This project is funded by [https://unwiredlabs.com Unwired Labs].
'''Please share your thoughts/ suggestions/ feedback/ queries here: [https://community.opencellid.org OpenCelliD Community]'''
{|border="0" width="680px" cellspacing="0"
|[[File:What_is_OpenCellID2.png|link=What_is_OpenCellID|250px]]
|align="right" | [[File:OpenCellID_how_to_join2.png|link=How_to_join|250px]]
|-
|style="height:8px;" |
|-
|[[File:OpenCellID_how_to_contribute2.png|link=How_to_contribute|250px]]
|align="right" | [[File:OpenCellID_view_the_data2.png|link=View_the_data|250px]]
|-
|style="height:8px;" |
|-
|[[File:OpenCellID I want to use the data2.png |link=http://wiki.opencellid.org/wiki/Commercial_users |250px]]
|align="right" | [[File:OpenCellID_scoring_lists2.png |link=http://wiki.opencellid.org/wiki/Licensing:|250px]]
|}</rev>
</revisions>
</page>
</pages>
</query>
</api>