API docs by Redocly

Search API (1.0.0)

License: Magic Lane Terms of Service

Search API suggests matching places based on free-form or incomplete queries with additional geographic and POI category filters

Locate

Find a location by name, geocode filters or POI category via POST

Locate POIs and addresses based on a text match and geographical filter:

  • location: around a latitude, longitude location
  • area: inside a polygon, circle, bbox area type
  • along: alomg a polyline path using radius field
Authorizations:
ApiKey
header Parameters
Authorization
required
string

User API token

Request Body schema: application/json
required

Locate parameters

text
string

Free text input

at
Array of numbers <float> [ items <float > ]

Reference coordinate as lon, lat array

object or object or object (in)
One of
required
object or object (polygon)
One of
polyline
required
string <Google polyline 5>

Polyline path

coords
Array of numbers[ items <float >[ items <float > ] ]

Polygon coordinates

object (circle)
center
required
Array of numbers <float> [ items <float > ]

Circle center as lon, lat array

radius
required
integer

Circle radius in meters

object (bbox)
east
required
number <double>

East longitude

west
required
number <double>

West longitude

south
required
number <double>

South longitude

north
required
number <double>

North longitude

object or object (along)
One of
polyline
required
string <Google polyline 5>
coords
Array of numbers[ items <float >[ items <float > ] ]

Polyline path coordinates

radius
required
integer

Along polyline radius in meters

categories
Array of strings
Items Enum: "gas_stations" "parking" "food&drink" "accommodation" "medical_services" "shopping" "car_services" "public_transport" "wiki" "education" "entertainment" "public_services" "geographic_area" "business" "sightseeing" "religious_places" "roadside" "sports" "hydrants" "emergency_services_support" "civil_emergency_infrastructure" "charging_stations" "bike_charging_stations" "bike_parking"

POI categories where the search should be performed

target
Array of strings
Items Enum: "pois" "addresses" "cities"

Search operation targets:

  • pois: search in map POIs
  • addresses: search in map addresses
  • cities: search in map cities
limit
integer
Default: 15

Results count limit

exact
boolean
Default: false

Exact match on text tokens

locale
string
Default: "en"

ISO 639-2 / ISO 639-3 language code for the result

fuzzy
boolean
Default: true

Enable text token autocorrection if they don't generate results

debug
boolean
Default: false

If true the result is beautified for easy human read

Responses

Response Schema: application/json
Array
object
copyrights
string
Array of objects
Array
coordinates
Array of numbers <float> [ items <float > ]

Place location as lon,lat float

entrance
Array of numbers <float> [ items <float > ]

Place entrance coordinates as lon,lat float

name
string

Place name

native_name
string

Place name in native language

description
string

Place description

object

Place address

street name
string
street number
string
postal code
string
settlement
string
city
string
county
string
state
string
country
string
country code
string
object

Place contact data

URL
Array of strings

List of location Urls

Phone
Array of strings

List of location phones

Email
Array of strings

List of location emails

distance
integer

Distance in meters from 'at' ref cooordinate

Request samples

Content type
application/json
{
  • "text": "aral",
  • "categories": [
    • "gas_stations"
    ],
  • "along": {
    • "polyline": "uvxmHe{yp@UmBcAuIUsCGk@IaAK}@YwDKkAMoAUwDG{AGgBGeD@m@Ba@n@}FH}@Bs@@y@@{@KmDGmBMyBI}@??GeAO}AKgAEm@UkEAKaDXs@Fe@DkAB??w@A{@IkAW_B]o@QaFqAyBo@mCoAmA_As@u@qA_B_BgCmCeEcA_BwIeNkAiBS_@kDqFsBcDkCcE}BcDoBsCcCmDgCsDw@iAS[gBcC_@c@a@c@aD{CsBsBm@o@QOgAaAcCwBsAoAo@s@e@s@]cAYuAAI_@qBSo@KWKa@GMOUY_@CE?IAIAGCGCGEECAEAC?E?EBEBCDQGUO[KQMq@_@a@SSAmBCy@C}AKYGu@SmBi@_@Km@Sg@Gc@A[Bo@LMFKDIDED{@p@sAfAKHSJSJeA\\o@Ni@Dk@?qASOEw@YsAw@GEu@g@uCoBmD_Cs@e@_BkAwAcAaC_BqBuAi@Ym@WYOe@Mi@My@Ec@?m@By@Jy@PoBn@qDbAeAXa@MSOIOK_@AE_@mBESIc@WsAMo@CQG]Km@]eBe@iC_@sBKk@Ec@?CG]MsBc@mDcBeLAKIe@w@wFSyASaBW}BAMCSQiCGiBAoBByABeAHyB@Kd@wJX_GHwAb@kIj@gLN{CtAgXLyAJy@N_A^}AvA{FnA}E^uA?A`A{Dl@cC@EHDF?HAFGDIBM@OAOEMGIGCIAGBGDEHECkByB{AoB_EmFaDoEsFwHmEcG{GgJ}@oAg@_Ae@gA]gA[{AWsBi@_HScCAQGwBAKHIDO@OAMCKEIGEGCG_@Ga@QgA_@oFgAoOk@wGSaBe@eDQ{@a@kBYiAm@wBm@oB}BoF{@sBsBkEg@y@}AuCgGaLoBqDq@oA{AuCeA}BkDgIaAmCeAyCiAmDu@kCOg@AG_BcGcBgHw@wDaA{FY{AkA_IkAkIeDoU}BePaBqLkBiMAICMqA_JIq@OcA_AyGg@kDw@iGs@yGiAmKQeBa@iFO_CIgAKoBMkBSeEE{@Cm@gBu`@oAsX}@sRUmFMeDYuHIsBQwFMeF?MAKEyBAUMuG?m@MkIEeCE_DC}@G_DQmISuHCg@Ai@c@}Lc@kKCgBIoBAaAFIBM@MAKAKGKGGIe@GWKmBMmAWqEY_F?aB[yHCUCWGUa@F]Du@HgBJW@s@@qB?iBEoAAs@AMAW?S?g@AM?U?uBAsA?sH@iBBG?]?WAW?Y?}ACyCC}@?iCAaCDqAFmBJ[@]B}CJo@DkAFqCNU@S@C?o@B[@uNh@G@oETY@mAJ}@Fg@DsAJUBkAH}CNsBNuEZeEVeAHs@F_AHw@HiAP_Dn@{A\\kAZUDYF[DYFSDYFq@Lg@JcIzA{NtC_ANUD_AJ}APaBLaEJiEAmBEwAK_AIaD]{BWkPeBkI{@qDa@sHw@cBMWCyEYqEQoACkBEeAAuOMsEEiCEc@?mEGoAAcAAuC?kAAqBCS?W?iBES?i@Ag@?aBEqAGg@AaAGkAGu@KiASc@Mq@OcDcAiBi@s@SyA_@_AOGAe@Gg@Ek@CyBGyNG}@AoEAgAAqHEaMGW?a@?a]QyDCeNIuB?U?M?cXKkA?qB?uAAyCAqPAi@AoA?oNIsBAO?Q?gDAqDAE?cBA{B?wGC}@Ec@C_AQ]GeBw@qAw@uBoAsBqA_B_Ac@QeAYy@Mu@GcAB_@Bk@JoGzASFODmJ~BiBf@sD|@c@LuBd@]DU@W?SAQC_AWaAc@aBq@aAUkAMiA@s@@g@@C?a@FQFe@Ng@Vu@h@o@b@[NYHSFQB[BO@SA]Ck@Eg@OM@KDkBKyAA{@AaA?qA@q@D_BFwBNkAFS?W@U?iBAiBC{BKkAG{@?kBAm@?S?mGAcA?aEAkHAoF?_CAmJIiUC}@?sC@oED_CBKAyCKmBOuASu@I{Em@mIaAIAYE{BW{YmDuOkB{W_D[EoC]iAM{BYkAMq@Iu@AG_@Qi@o@kAEKISSQGGaAaBWYeAqBe@eAk@u@k@o@k@m@w@o@w@o@w@k@k@aBwCWY{@gBg@q@u@q@OS{@uAEG[g@QQYKg@Ko@RsAbAk@Pm@H]Bm@FqA@cDEc@EkBGcAIeCWyDe@kESaAO{@Ky@HgA",
    • "radius": 300
    },
  • "limit": 2
}

Response samples

Content type
application/json
[
  • {
    • "info": {
      • "copyrights": "MagicLane"
      },
    • "results": [
      • {
        • "coordinates": [
          • 8.360695,
          • 49.845291
          ],
        • "name": "Aral",
        • "description": "Gas Station",
        • "address": {
          • "street number": "2",
          • "postal code": "55276",
          • "city": "Oppenheim",
          • "county": "Landkreis Mainz-Bingen",
          • "state": "Rhineland-Palatinate",
          • "country": "Germany",
          • "country code": "DEU"
          },
        • "contact": {},
        • "native_name": "Aral",
        • "distance": 36573
        },
      • {
        • "coordinates": [
          • 8.269084,
          • 50.066388
          ],
        • "name": "Aral",
        • "description": "Gas Station",
        • "address": {
          • "street name": "Berliner Straße",
          • "street number": "68",
          • "postal code": "65189",
          • "settlement": "Südost",
          • "city": "Wiesbaden",
          • "state": "Hesse",
          • "country": "Germany",
          • "country code": "DEU"
          },
        • "contact": {},
        • "native_name": "Aral",
        • "distance": 65183
        }
      ]
    }
]