The current version (and the only one for now) of this API. New versions will be added but later, but still, older ones will continue be available.
version = 0.1
Token string
The token for the search. Searches results are limited for all tokens to reduce server overhead. Note: Tokens limited to more results is planned.
token = *Demo*
Latitude float
The latitude (using WGS84 projection) of the center of the search.
lat = 45.95
Longitude float
The longitude (using WGS84 projection) of the center of the search.
lon = -0.97
Distance integer
The radius for the search, in kilometers, around the specified latitude/longitude.
distance = 5 (km)
Types [string]
All types used to filter results. This list must contains at least one type.
2nd Generation
2g
3rd Generation
3g
4th Generation
4g
5th Generation
5g
types = [ building=yes ]
Operators [string]
All operators used to filter antennas. If no operators are selected, antennas from all operators would be returned. See this page for the details of all operators supported.
Bouygues Telecom
Q581438
Dauphin Telecom
dauphin
Digicel
Q2117506
Free Mobile
Q2058517
Free Mobile Caraïbes
free-caraibes
Free Mobile Réunion
Q32560599
Globaltel
globaltel
OPT Polynésie
Q3349602
Maoré Mobile
maore
Onati
onati
Orange
Q1431486
Vodafone
Q122141
SFR
Q218765
Outremer Telecom
Q3358661
SRR
sfr-reunion
SPM Telecom
spm
SPT
spt
UTS Caraïbes
Q21079550
Ora Mobile
ora
Zeop
zeop
operators = [ Q1234 ]
Response
Status integer
The HTTP status code.
It can be a success code: • 200 if the request has been executed with success. On success, data will contain matching results data, and error will be null.
Or it can an error code: • 404 if the token= parameter is missing, empty or unknown. • 422 if one or many parameters are missing, or if the types list is empty. • 429 if you've already sent too much requests for the hour or for today. On error, data will be an empty dictionary, and error will contain a message describing the error.
status = 200
Error string or null
A detailled explanation for the status code returned. The value is null on success (when status = 200).
error = null
Results [object]
The list of results, or an empty list if none, and will not be returned on error. A sample of the returned results:
data/results = [
{ name = "An Item Name" }
]
Sources dictionary
The date source for each different result, with the brand code as key and the date of the last update as value. This dictionary will empty if there is no results, and will not be returned on error. A sample of the sources:
The complete URL to request the next results page if the server has more results that returned by the current request. The value will be null if there is no more results, and will not be returned on error.
data/next = null
Remaining integer
The total number of results the API will return for next requests until the limit has been reached (see status parameter description for more information about errors). Once at 0, it's necessary to wait before to get access to more information.