Repository navigation
Expand file tree
/
Copy pathgoogle_maps.json
More file actions
783 lines (783 loc) · 22.5 KB
/
Copy pathgoogle_maps.json
File metadata and controls
783 lines (783 loc) · 22.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
{
"engine": "google_maps",
"params": {
"q": {
"description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Maps search. The parameter is only required if type is set to `search`.",
"group": "search_query"
},
"ll": {
"description": "Parameter defines the GPS coordinates for the search origin. Its value must match the following format: `@` + `latitude` + `,` + `longitude` + `,` + `zoom/map_height` This will form a string that looks like: `@40.7455096,-74.0083012,14z` or `@43.8521864,11.2168835,10410m`. The minimum `zoom` value is `3z` (the map is completely zoomed out). The maximum effective `zoom` value depends on the location, ranging from `18z` to `23z`. Some locations may support even higher `zoom` values, so we allow values up to `30z`. Alternatively, you can specify `map_height` in meters. The minimum value is `1m`. The maximum value is `15028132m`, which roughly equals `3z` on the equator. Parameter is applied only when type is set to `search`. Parameter can't be used with ll, lat, lon, z, or m parameters. Results are not guaranteed to be within the requested geographic location.",
"group": "geographic_location"
},
"location": {
"type": "location",
"description": "Parameter defines the location, whose GPS coordinates are used for the search origin. At the end, coordinates are encoded as part of the ll parameter. Parameter should be used with z or m parameter. Parameter can't be used with ll, lat or lon parameters.",
"group": "geographic_location"
},
"lat": {
"type": "number",
"description": "Parameter defines a GPS latitude for the search origin. At the end, it is encoded as part of the ll parameter. Parameter is required when using lon parameter. Parameter should be used with z or m parameter. Parameter can't be used with ll or location parameters.",
"group": "geographic_location"
},
"lon": {
"type": "number",
"description": "Parameter defines a GPS longitude for the search origin. At the end, it is encoded as part of the ll parameter. Parameter is required when using lat parameter. Parameter should be used with z or m parameter. Parameter can't be used with ll or location parameters.",
"group": "geographic_location"
},
"z": {
"type": "number",
"description": "Parameter defines a map zoom level. The minimum value is `3` (the map is completely zoomed out). The maximum effective value depends on the location, ranging from `18` to `23`. Some locations may support even higher values, so we allow values up to `30`. At the end, it is encoded as part of the ll parameter. Either z or m is required when using location or lat/lon parameters.",
"group": "geographic_location"
},
"m": {
"type": "number",
"description": "Parameter defines a map height in meters. The minimum value is `1`. The maximum value is `15028132`, which roughly equals `3z` on the equator. At the end, it is encoded as part of the ll parameter. Either m or z is required when using location or lat/lon parameters.",
"group": "geographic_location"
},
"nearby": {
"type": "checkbox",
"description": "Parameter forces to return search results closer to the specified location. Parameter is highly recommended when q parameter includes `near me` keywords. Parameter is not recommended when q parameter includes location. Parameter should be used with ll, location, or lat/lon parameters.",
"group": "geographic_location"
},
"google_domain": {
"type": "select",
"options": [
"google.com",
"google.ad",
"google.ae",
"google.com.af",
"google.com.ag",
"google.com.ai",
"google.al",
"google.am",
"google.co.ao",
"google.com.ar",
"google.as",
"google.at",
"google.com.au",
"google.az",
"google.ba",
"google.com.bd",
"google.be",
"google.bf",
"google.bg",
"google.com.bh",
"google.bi",
"google.bj",
"google.com.bn",
"google.com.bo",
"google.com.br",
"google.bs",
"google.bt",
"google.co.bw",
"google.by",
"google.com.bz",
"google.ca",
"google.com.kh",
"google.cd",
"google.cf",
"google.cg",
"google.ch",
"google.ci",
"google.co.ck",
"google.cl",
"google.cm",
"google.com.co",
"google.co.cr",
"google.com.cu",
"google.cv",
"google.com.cy",
"google.cz",
"google.de",
"google.dj",
"google.dk",
"google.dm",
"google.com.do",
"google.dz",
"google.com.ec",
"google.ee",
"google.com.eg",
"google.es",
"google.com.et",
"google.fi",
"google.fm",
"google.com.fj",
"google.fr",
"google.ga",
"google.ge",
"google.com.gh",
"google.com.gi",
"google.gl",
"google.gm",
"google.gp",
"google.gr",
"google.com.gt",
"google.gy",
"google.com.hk",
"google.hn",
"google.hr",
"google.ht",
"google.hu",
"google.co.id",
"google.iq",
"google.ie",
"google.co.il",
"google.co.in",
"google.is",
"google.it",
"google.je",
"google.com.jm",
"google.jo",
"google.co.jp",
"google.co.ke",
"google.ki",
"google.kg",
"google.co.kr",
"google.com.kw",
"google.kz",
"google.la",
"google.com.lb",
"google.li",
"google.lk",
"google.co.ls",
"google.lt",
"google.lu",
"google.lv",
"google.com.ly",
"google.co.ma",
"google.md",
"google.mg",
"google.mk",
"google.ml",
"google.com.mm",
"google.mn",
"google.ms",
"google.com.mt",
"google.mu",
"google.mv",
"google.mw",
"google.com.mx",
"google.com.my",
"google.co.mz",
"google.com.na",
"google.ne",
"google.com.ng",
"google.com.ni",
"google.nl",
"google.no",
"google.com.np",
"google.nr",
"google.nu",
"google.co.nz",
"google.com.om",
"google.com.pk",
"google.com.pa",
"google.com.pe",
"google.com.ph",
"google.pl",
"google.com.pg",
"google.com.pr",
"google.ps",
"google.pt",
"google.com.py",
"google.com.qa",
"google.ro",
"google.rs",
"google.ru",
"google.rw",
"google.com.sa",
"google.com.sb",
"google.sc",
"google.se",
"google.com.sg",
"google.sh",
"google.si",
"google.sk",
"google.com.sl",
"google.sn",
"google.sm",
"google.so",
"google.sr",
"google.com.sv",
"google.td",
"google.tg",
"google.co.th",
"google.com.tj",
"google.tk",
"google.tl",
"google.tm",
"google.to",
"google.tn",
"google.com.tr",
"google.tt",
"google.com.tw",
"google.co.tz",
"google.com.ua",
"google.co.ug",
"google.co.uk",
"google.com.uy",
"google.co.uz",
"google.com.vc",
"google.co.ve",
"google.vg",
"google.co.vi",
"google.com.vn",
"google.vu",
"google.ws",
"google.co.za",
"google.co.zm",
"google.co.zw"
],
"description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.",
"group": "localization"
},
"hl": {
"type": "select",
"options": [
"af",
"sq",
"am",
"ar",
"hy",
"az",
"eu",
"be",
"bn",
"bs",
"bg",
"my",
"ca",
"zh",
"zh-cn",
"zh-hk",
"zh-tw",
"hr",
"cs",
"da",
"nl",
"en",
"en-au",
"en-gb",
"et",
"fa",
"fil",
"fi",
"fr",
"fr-ca",
"gl",
"ka",
"de",
"el",
"gu",
"iw",
"hi",
"hu",
"is",
"id",
"it",
"ja",
"kn",
"kk",
"km",
"ko",
"ky",
"lo",
"lv",
"lt",
"mk",
"ms",
"ml",
"mr",
"mn",
"ne",
"no",
"pl",
"pt",
"pt-br",
"pt-pt",
"pa",
"ro",
"ru",
"sr",
"si",
"sk",
"sl",
"es",
"es-419",
"sw",
"sv",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"uz",
"vi",
"zu"
],
"description": "Parameter defines the language to use for the Google Maps search. It's a two or three-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French), optionally followed by a two-letter or three-digit region code (e.g., `en-gb` for British English, or `es-419` for Latin American Spanish). Head to the Google Maps languages page for a full list of supported Google Maps languages.",
"group": "localization"
},
"gl": {
"type": "select",
"options": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"aq",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"ba",
"bw",
"bv",
"br",
"io",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cg",
"cd",
"ck",
"cr",
"ci",
"hr",
"cu",
"cy",
"cz",
"dk",
"dj",
"dm",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"tf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hm",
"va",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"je",
"jm",
"jp",
"jo",
"kz",
"ke",
"ki",
"kp",
"kr",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"nl",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"kn",
"lc",
"pm",
"vc",
"ws",
"sm",
"st",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"es",
"lk",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"tw",
"tj",
"tz",
"th",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"ug",
"ua",
"ae",
"uk",
"gb",
"us",
"um",
"uy",
"uz",
"vu",
"ve",
"vn",
"vg",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw"
],
"description": "Parameter defines the country to use for the Google Maps search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries. Parameter only affects Place Results API.",
"group": "localization"
},
"data": {
"description": "This parameter is deprecated, please use place\\_id or data\\_cid instead. Parameter can be used to filter the search results. You can visit Google Maps website, set filters you want and simply copy the data value from their URL to SerpApi URL. One of the uses of the parameter is to search for a specific place; therefore, it is required if the type is set to `place`. To use the data parameter to search for a specific place, it needs to be constructed in the following sequence: `!4m5!3m4!1s` + `data_id` + `!8m2!3d` + `latitude` + `!4d` + `longitude` This will form a string that looks like this: `!4m5!3m4!1s0x89c259b7abdd4769:0xc385876db174521a!8m2!3d40.750231!4d-74.004019`. You can find the `data_id` using our Google Maps API.",
"group": "advanced_google_maps_parameters"
},
"place_id": {
"description": "Parameter defines the unique reference to a place in Google Maps. Place IDs are available for most locations, including businesses, landmarks, parks, and intersections. You can find the place\\_id using our Google Maps API. You can read more about Place IDs here. place\\_id can be used without any other optional parameter. place\\_id and data\\_cid can't be used together. Parameter should not be confused with place\\_id in Google Search API and Google Local API which are the same as data\\_cid in Google Maps API.",
"group": "advanced_google_maps_parameters"
},
"data_cid": {
"description": "Parameter defines the Google CID (customer identifier) of a place. This parameter can be found in Google Maps API local results, as well as in Google Search API and Google Local API local results under the name of place\\_id. You can also acquire it using Google's CID converter. data\\_cid can be used without any other optional parameter. data\\_cid and place\\_id can't be used together.",
"group": "advanced_google_maps_parameters"
},
"type": {
"required": true,
"type": "select",
"options": [
"search",
"place"
],
"description": "Parameter defines the type of search you want to make. It can be set to: `search` - returns a list of results for the set q parameter, `place` - returns results for a specific place when data parameter is set Parameter is not required when using place\\_id or data\\_cid.",
"group": "search_type"
},
"min_price": {
"type": "number",
"description": "Parameter defines the lower bound of the place price range. The places with the price range overlapping with the specified one will be returned. Parameter is applicable to searches expected to return places with numerical `price` data (e.g., cafes, restaurants, bars, etc.)",
"group": "advanced_filters"
},
"max_price": {
"type": "number",
"description": "Parameter defines the upper bound of the place price range. The places with the price range overlapping with the specified one will be returned. Parameter is applicable to searches expected to return places with numerical `price` data (e.g., cafes, restaurants, bars, etc.)",
"group": "advanced_filters"
},
"min_rating": {
"type": "select",
"options": [
"2.0",
"2.5",
"3.0",
"3.5",
"4.0",
"4.5"
],
"description": "Parameter defines the preferred minimum rating of the place. Places without a rating or with a rating below the specified value can still be returned, but with reduced relevance. Options: `2.0` - 2.0 `2.5` - 2.5 `3.0` - 3.0 `3.5` - 3.5 `4.0` - 4.0 `4.5` - 4.5",
"group": "advanced_filters"
},
"open_state": {
"type": "select",
"options": [
"now",
"24h"
],
"description": "Parameter defines the open state of the place. Options: `now` - Open now `24h` - Open 24 hours Parameter can't be used with open\\_on\\_day or open\\_at\\_hour parameters.",
"group": "advanced_filters"
},
"open_on_day": {
"type": "select",
"options": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat",
"sun"
],
"description": "Parameter defines the day on which the place is open. Options: `mon` - Monday `tue` - Tuesday `wed` - Wednesday `thu` - Thursday `fri` - Friday `sat` - Saturday `sun` - Sunday Parameter can't be used with open\\_state parameter.",
"group": "advanced_filters"
},
"open_at_hour": {
"type": "select",
"options": [
[
"0",
"Midnight"
],
[
"1",
"1:00 AM"
],
[
"2",
"2:00 AM"
],
[
"3",
"3:00 AM"
],
[
"4",
"4:00 AM"
],
[
"5",
"5:00 AM"
],
[
"6",
"6:00 AM"
],
[
"7",
"7:00 AM"
],
[
"8",
"8:00 AM"
],
[
"9",
"9:00 AM"
],
[
"10",
"10:00 AM"
],
[
"11",
"11:00 AM"
],
[
"12",
"Noon"
],
[
"13",
"1:00 PM"
],
[
"14",
"2:00 PM"
],
[
"15",
"3:00 PM"
],
[
"16",
"4:00 PM"
],
[
"17",
"5:00 PM"
],
[
"18",
"6:00 PM"
],
[
"19",
"7:00 PM"
],
[
"20",
"8:00 PM"
],
[
"21",
"9:00 PM"
],
[
"22",
"10:00 PM"
],
[
"23",
"11:00 PM"
]
],
"description": "Parameter defines the hour at which the place is open. Options: `0` - Midnight `1` - 1:00 AM `2` - 2:00 AM `3` - 3:00 AM `4` - 4:00 AM `5` - 5:00 AM `6` - 6:00 AM `7` - 7:00 AM `8` - 8:00 AM `9` - 9:00 AM `10` - 10:00 AM `11` - 11:00 AM `12` - Noon `13` - 1:00 PM `14` - 2:00 PM `15` - 3:00 PM `16` - 4:00 PM `17` - 5:00 PM `18` - 6:00 PM `19` - 7:00 PM `20` - 8:00 PM `21` - 9:00 PM `22` - 10:00 PM `23` - 11:00 PM Parameter should be used with open\\_on\\_day parameter. Parameter can't be used with open\\_state parameter.",
"group": "advanced_filters"
},
"start": {
"type": "number",
"description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `20` is the 2nd page of results, `40` is the 3rd page of results, etc.). We recommend starting with `0` and increasing by `20` for the next page. There is no hard limit on the maximum offset number, but we recommend a maximum of `100` (page six) which is the same behavior as with the Google Maps web app. More than that, the result might be duplicated or irrelevant.",
"group": "pagination"
}
},
"common_params": {
"engine": {
"required": true,
"description": "Set parameter to `google_maps` to use the Google Maps API engine.",
"group": "serpapi_parameters"
},
"no_cache": {
"type": "checkbox",
"description": "Parameter will force SerpApi to fetch the Google Maps results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no\\_cache and async parameters should not be used together.",
"group": "serpapi_parameters"
},
"async": {
"description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no\\_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.",
"group": "serpapi_parameters"
},
"zero_trace": {
"description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.",
"group": "serpapi_parameters"
},
"api_key": {
"required": true,
"description": "Parameter defines the SerpApi private key to use.",
"group": "serpapi_parameters"
},
"output": {
"description": "Parameter defines the format of the result. It can be set to `json` (default) to get a structured JSON of the results, `html` to get the raw HTML retrieved, or `md` to get a Markdown-formatted version optimized for LLMs and AI agents.",
"group": "serpapi_parameters"
},
"json_restrictor": {
"description": "Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details.",
"group": "serpapi_parameters"
}
}
}