-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.json
More file actions
3614 lines (3614 loc) · 206 KB
/
openapi.json
File metadata and controls
3614 lines (3614 loc) · 206 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
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"info": {
"_postman_id": "607034d8-111f-44c3-9824-05476fc6acbb",
"name": "IPGeolocation.io",
"description": "## IPGeolocation.io API Collection\n\nComplete API collection for all IPGeolocation.io v3 endpoints.\n\n### Authentication\nAll requests require an API key passed as the `apiKey` query parameter.\n\n**Setup:** Open the collection → Variables tab → set your `apiKey` value.\n\nGet your API key at https://app.ipgeolocation.io/\n\n---\n\n### API Groups\n- **IP Geolocation API**: Single and bulk IP/domain lookups\n- **IP Security API**: VPN, proxy, Tor, bot, and threat intelligence\n- **ASN API**: Autonomous System Number metadata\n- **Abuse Contact API**: Registry-based abuse contact info\n- **Timezone API**: Timezone lookup and time conversion\n- **User-Agent API**: Parse browser, device, and OS details\n- **Astronomy API**: Sunrise, sunset, moon phase, and more\n\nFull documentation: https://ipgeolocation.io/documentation",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "apiKey",
"type": "string"
},
{
"key": "value",
"value": "{{apiKey}}",
"type": "string"
},
{
"key": "in",
"value": "query",
"type": "string"
}
]
},
"variable": [
{
"key": "apiKey",
"value": "",
"type": "string",
"description": "Your IPGeolocation.io API key.\n\nGet yours at: https://app.ipgeolocation.io/\n\nPaste your key in the 'Current Value' field. It will be automatically appended as ?apiKey=... on every request in this collection."
}
],
"item": [
{
"name": "IP Geolocation API",
"description": "IP geolocation API endpoints for looking up geographic location, network routing,\nASN ownership, company attribution, timezone, currency, security threat intelligence,\nabuse contact, and User-Agent data. Accepts IPv4 addresses, IPv6 addresses, and\ndomain names. The single lookup endpoint (`GET /v3/ipgeo`) resolves one IP or domain\nper request. The bulk lookup endpoint (`POST /v3/ipgeo-bulk`) accepts up to 50,000\nentries per request and requires a paid plan.",
"item": [
{
"name": "Single IP Geolocation Lookup",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.ipgeolocation.io/v3/ipgeo",
"protocol": "https",
"host": [
"api",
"ipgeolocation",
"io"
],
"path": [
"v3",
"ipgeo"
],
"query": [
{
"key": "ip",
"value": "8.8.8.8",
"description": "An IPv4 address, IPv6 address, or domain name to look up. When omitted, the API resolves the public IP of the requesting client. Empty or whitespace-only values are treated the same as omission and resolve caller IP. Domain lookups require a paid plan. Pass `ip` only once. If multiple `ip` query parameters are sent, values may be merged and treated as invalid input (HTTP 400).",
"disabled": true
},
{
"key": "lang",
"value": "en",
"description": "Language code for translated location names. Defaults to `en`. Non-English responses require a paid plan. Free plans always receive English regardless of this parameter. Unsupported `lang` values return HTTP 400. Language code. Supported values: `en`, `de`, `ru`, `ja`, `fr`, `cn`, `es`, `cs`, `it`, `ko`, `fa`, `pt`. Defaults to `en`.",
"disabled": true
},
{
"key": "include",
"value": "security",
"description": "Comma-separated list of optional data modules to add to the response. These are not returned by default. Requires a paid plan. If multiple hostname options are passed in `include`, hostname resolution uses this precedence order: `liveHostname` first, then `hostname`, then `hostnameFallbackLive`. If none is specified, the `hostname` field is not returned. For `user_agent`, the API parses the `User-Agent` header from the request. For server-side calls, forward your visitor's User-Agent string in the header so the parsed result matches the actual visitor. For additional query parameters (`include`, `fields`, `excludes`, `output`), unknown values are ignored. The API still returns HTTP 200 and applies only recognized values. Free plan behavior for `include=*`: the API returns HTTP 200 and ignores the include request, returning only base response fields. In contrast, specific include values such as `include=security` return HTTP 401 on free plans.",
"disabled": true
},
{
"key": "fields",
"value": "location.city,security.threat_score,security.is_vpn",
"description": "Comma-separated list of fields or objects to return. Everything else is omitted. The `ip` field is always returned regardless of this filter. Supports dot-notation for nested fields: `location.city`, `asn.organization`. To return an entire object, use the object key: `location`, `security`. If a field belongs to an optional module (e.g. `security.threat_score`), you must also pass the corresponding `include` value. If you omit `include`, the request still succeeds, but fields from optional modules are not returned. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If the same field or object is specified in `include`, `fields`, and `excludes`, `include` takes priority over both `fields` and `excludes`. If you list both an object key and one of its nested fields separated by comma (e.g. `security,security.threat_score`), the full object is returned. Unknown field paths are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "excludes",
"value": "location.continent_code,currency,company.type",
"description": "Comma-separated list of fields or objects to remove from the response. The `ip` field cannot be excluded. Supports dot-notation for nested fields: `location.continent_code`. To exclude an entire object, use the object key: `currency`, `time_zone`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If the same field or object is specified in `include`, `fields`, and `excludes`, `include` takes priority over both `fields` and `excludes`. Unknown fields or object keys in `excludes` are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "output",
"value": "json",
"description": "Desired response format. Defaults to `json` if not specified. You can also control the format using the `Accept` header (`application/json`, `application/xml`, or `text/xml`). If both are provided, the `output` parameter takes precedence. If `output` is unknown or unsupported, it is ignored and the response defaults to JSON (`application/json`) with HTTP 200. Supported values: `json`, `xml`. Defaults to `json`.",
"disabled": true
}
]
},
"description": "Returns geolocation and enrichment data for a single IPv4 address, IPv6 address,\nor domain name. When `ip` is omitted, the API resolves the caller's public IP\nautomatically, which is useful for client-side lookups.\n\nThe base response always includes `location`, `country_metadata`, `currency`,\n`asn`, and `time_zone`. Paid plans also get `network` and `company` by default.\n\nUse the `include` parameter to add optional modules such as `security`, `abuse`,\n`user_agent`, `geo_accuracy`, `dma_code`, and hostname resolution.\n\nUse `fields` and `excludes` to control exactly which parts of the response you\nreceive. This reduces payload size and can improve response times."
},
"response": [
{
"name": "200 OK – Paid plan, all modules included",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.ipgeolocation.io/v3/ipgeo",
"protocol": "https",
"host": [
"api",
"ipgeolocation",
"io"
],
"path": [
"v3",
"ipgeo"
],
"query": [
{
"key": "ip",
"value": "91.128.103.196",
"description": "An IPv4 address, IPv6 address, or domain name to look up. When omitted, the API resolves the public IP of the requesting client. Empty or whitespace-only values are treated the same as omission and resolve caller IP. Domain lookups require a paid plan. Pass `ip` only once. If multiple `ip` query parameters are sent, values may be merged and treated as invalid input (HTTP 400).",
"disabled": false
},
{
"key": "lang",
"value": "en",
"description": "Language code for translated location names. Defaults to `en`. Non-English responses require a paid plan. Free plans always receive English regardless of this parameter. Unsupported `lang` values return HTTP 400. Language code. Supported values: `en`, `de`, `ru`, `ja`, `fr`, `cn`, `es`, `cs`, `it`, `ko`, `fa`, `pt`. Defaults to `en`.",
"disabled": true
},
{
"key": "include",
"value": "*",
"description": "Comma-separated list of optional data modules to add to the response. These are not returned by default. Requires a paid plan. If multiple hostname options are passed in `include`, hostname resolution uses this precedence order: `liveHostname` first, then `hostname`, then `hostnameFallbackLive`. If none is specified, the `hostname` field is not returned. For `user_agent`, the API parses the `User-Agent` header from the request. For server-side calls, forward your visitor's User-Agent string in the header so the parsed result matches the actual visitor. For additional query parameters (`include`, `fields`, `excludes`, `output`), unknown values are ignored. The API still returns HTTP 200 and applies only recognized values. Free plan behavior for `include=*`: the API returns HTTP 200 and ignores the include request, returning only base response fields. In contrast, specific include values such as `include=security` return HTTP 401 on free plans.",
"disabled": false
},
{
"key": "fields",
"value": "location.city,security.threat_score,security.is_vpn",
"description": "Comma-separated list of fields or objects to return. Everything else is omitted. The `ip` field is always returned regardless of this filter. Supports dot-notation for nested fields: `location.city`, `asn.organization`. To return an entire object, use the object key: `location`, `security`. If a field belongs to an optional module (e.g. `security.threat_score`), you must also pass the corresponding `include` value. If you omit `include`, the request still succeeds, but fields from optional modules are not returned. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If the same field or object is specified in `include`, `fields`, and `excludes`, `include` takes priority over both `fields` and `excludes`. If you list both an object key and one of its nested fields separated by comma (e.g. `security,security.threat_score`), the full object is returned. Unknown field paths are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "excludes",
"value": "location.continent_code,currency,company.type",
"description": "Comma-separated list of fields or objects to remove from the response. The `ip` field cannot be excluded. Supports dot-notation for nested fields: `location.continent_code`. To exclude an entire object, use the object key: `currency`, `time_zone`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If the same field or object is specified in `include`, `fields`, and `excludes`, `include` takes priority over both `fields` and `excludes`. Unknown fields or object keys in `excludes` are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "output",
"value": "json",
"description": "Desired response format. Defaults to `json` if not specified. You can also control the format using the `Accept` header (`application/json`, `application/xml`, or `text/xml`). If both are provided, the `output` parameter takes precedence. If `output` is unknown or unsupported, it is ignored and the response defaults to JSON (`application/json`) with HTTP 200. Supported values: `json`, `xml`. Defaults to `json`.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Credits-Charged",
"value": "1"
}
],
"body": "{\n \"ip\": \"91.128.103.196\",\n \"hostname\": \"91.128.103.196\",\n \"location\": {\n \"continent_code\": \"EU\",\n \"continent_name\": \"Europe\",\n \"country_code2\": \"SE\",\n \"country_code3\": \"SWE\",\n \"country_name\": \"Sweden\",\n \"country_name_official\": \"Kingdom of Sweden\",\n \"country_capital\": \"Stockholm\",\n \"state_prov\": \"Stockholms län\",\n \"state_code\": \"SE-AB\",\n \"district\": \"Stockholm\",\n \"city\": \"Stockholm\",\n \"locality\": \"Stockholm\",\n \"accuracy_radius\": \"4.395\",\n \"confidence\": \"high\",\n \"dma_code\": \"\",\n \"zipcode\": \"164 40\",\n \"latitude\": \"59.40510\",\n \"longitude\": \"17.95510\",\n \"is_eu\": true,\n \"country_flag\": \"https://ipgeolocation.io/static/flags/se_64.png\",\n \"geoname_id\": \"9972319\",\n \"country_emoji\": \"🇸🇪\"\n },\n \"country_metadata\": {\n \"calling_code\": \"+46\",\n \"tld\": \".se\",\n \"languages\": [\n \"sv-SE\",\n \"se\",\n \"sma\",\n \"fi-SE\"\n ]\n },\n \"network\": {\n \"connection_type\": \"\",\n \"route\": \"91.128.0.0/14\",\n \"is_anycast\": false\n },\n \"currency\": {\n \"code\": \"SEK\",\n \"name\": \"Swedish Krona\",\n \"symbol\": \"kr\"\n },\n \"asn\": {\n \"as_number\": \"AS1257\",\n \"organization\": \"Tele2 Sverige AB\",\n \"country\": \"SE\",\n \"type\": \"ISP\",\n \"domain\": \"tele2.com\",\n \"date_allocated\": \"2024-12-13\",\n \"rir\": \"RIPE\"\n },\n \"company\": {\n \"name\": \"Tele2 Sverige AB\",\n \"type\": \"ISP\",\n \"domain\": \"tele2.com\"\n },\n \"security\": {\n \"threat_score\": 0,\n \"is_tor\": false,\n \"is_proxy\": false,\n \"proxy_provider_names\": [],\n \"proxy_confidence_score\": 0,\n \"proxy_last_seen\": \"\",\n \"is_residential_proxy\": false,\n \"is_vpn\": false,\n \"vpn_provider_names\": [],\n \"vpn_confidence_score\": 0,\n \"vpn_last_seen\": \"\",\n \"is_relay\": false,\n \"relay_provider_name\": \"\",\n \"is_anonymous\": false,\n \"is_known_attacker\": false,\n \"is_bot\": false,\n \"is_spam\": false,\n \"is_cloud_provider\": false,\n \"cloud_provider_name\": \"\"\n },\n \"abuse\": {\n \"route\": \"91.128.0.0/14\",\n \"country\": \"SE\",\n \"name\": \"Swipnet Staff\",\n \"organization\": \"\",\n \"kind\": \"group\",\n \"address\": \"Tele2 AB/Swedish IP Network, IP Registry, Torshamnsgatan 17 164 40 Kista SWEDEN\",\n \"emails\": [\n \"abuse@tele2.com\"\n ],\n \"phone_numbers\": [\n \"+46 8 5626 42 10\"\n ]\n },\n \"time_zone\": {\n \"name\": \"Europe/Stockholm\",\n \"offset\": 1,\n \"offset_with_dst\": 1,\n \"current_time\": \"2026-02-13 09:19:24.410+0100\",\n \"current_time_unix\": 1770970764.41,\n \"current_tz_abbreviation\": \"CET\",\n \"current_tz_full_name\": \"Central European Standard Time\",\n \"standard_tz_abbreviation\": \"CET\",\n \"standard_tz_full_name\": \"Central European Standard Time\",\n \"is_dst\": false,\n \"dst_savings\": 0,\n \"dst_exists\": true,\n \"dst_tz_abbreviation\": \"CEST\",\n \"dst_tz_full_name\": \"Central European Summer Time\",\n \"dst_start\": {\n \"utc_time\": \"2026-03-29 TIME 01:00\",\n \"duration\": \"+1.00H\",\n \"gap\": true,\n \"date_time_after\": \"2026-03-29 TIME 03:00\",\n \"date_time_before\": \"2026-03-29 TIME 02:00\",\n \"overlap\": false\n },\n \"dst_end\": {\n \"utc_time\": \"2026-10-25 TIME 01:00\",\n \"duration\": \"-1.00H\",\n \"gap\": false,\n \"date_time_after\": \"2026-10-25 TIME 02:00\",\n \"date_time_before\": \"2026-10-25 TIME 03:00\",\n \"overlap\": true\n }\n },\n \"user_agent\": {\n \"user_agent_string\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/143.0.0.0 Safari/537.36 Edg/143.0.0.0\",\n \"name\": \"Edge\",\n \"type\": \"Browser\",\n \"version\": \"143\",\n \"version_major\": \"143\",\n \"device\": {\n \"name\": \"Linux Desktop\",\n \"type\": \"Desktop\",\n \"brand\": \"Unknown\",\n \"cpu\": \"Intel x86_64\"\n },\n \"engine\": {\n \"name\": \"Blink\",\n \"type\": \"Browser\",\n \"version\": \"143\",\n \"version_major\": \"143\"\n },\n \"operating_system\": {\n \"name\": \"Linux\",\n \"type\": \"Desktop\",\n \"version\": \"??\",\n \"version_major\": \"??\",\n \"build\": \"??\"\n }\n }\n}"
},
{
"name": "200 OK – Free plan default response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.ipgeolocation.io/v3/ipgeo",
"protocol": "https",
"host": [
"api",
"ipgeolocation",
"io"
],
"path": [
"v3",
"ipgeo"
],
"query": [
{
"key": "ip",
"value": "165.227.0.0",
"description": "An IPv4 address, IPv6 address, or domain name to look up. When omitted, the API resolves the public IP of the requesting client. Empty or whitespace-only values are treated the same as omission and resolve caller IP. Domain lookups require a paid plan. Pass `ip` only once. If multiple `ip` query parameters are sent, values may be merged and treated as invalid input (HTTP 400).",
"disabled": false
},
{
"key": "fields",
"value": "location.city",
"description": "Comma-separated list of fields or objects to return. Everything else is omitted. The `ip` field is always returned regardless of this filter. Supports dot-notation for nested fields: `location.city`, `asn.organization`. To return an entire object, use the object key: `location`, `security`. If a field belongs to an optional module (e.g. `security.threat_score`), you must also pass the corresponding `include` value. If you omit `include`, the request still succeeds, but fields from optional modules are not returned. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If the same field or object is specified in `include`, `fields`, and `excludes`, `include` takes priority over both `fields` and `excludes`. If you list both an object key and one of its nested fields separated by comma (e.g. `security,security.threat_score`), the full object is returned. Unknown field paths are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "excludes",
"value": "location.continent_code,currency",
"description": "Comma-separated list of fields or objects to remove from the response. The `ip` field cannot be excluded. Supports dot-notation for nested fields: `location.continent_code`. To exclude an entire object, use the object key: `currency`, `time_zone`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If the same field or object is specified in `include`, `fields`, and `excludes`, `include` takes priority over both `fields` and `excludes`. Unknown fields or object keys in `excludes` are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "output",
"value": "json",
"description": "Desired response format. Defaults to `json` if not specified. You can also control the format using the `Accept` header (`application/json`, `application/xml`, or `text/xml`). If both are provided, the `output` parameter takes precedence. If `output` is unknown or unsupported, it is ignored and the response defaults to JSON (`application/json`) with HTTP 200. Supported values: `json`, `xml`. Defaults to `json`.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Credits-Charged",
"value": "1"
}
],
"body": "{\n \"ip\": \"165.227.0.0\",\n \"location\": {\n \"continent_code\": \"NA\",\n \"continent_name\": \"North America\",\n \"country_code2\": \"US\",\n \"country_code3\": \"USA\",\n \"country_name\": \"United States\",\n \"country_name_official\": \"United States of America\",\n \"country_capital\": \"Washington, D.C.\",\n \"state_prov\": \"California\",\n \"state_code\": \"US-CA\",\n \"district\": \"Santa Clara County\",\n \"city\": \"Santa Clara\",\n \"zipcode\": \"95051\",\n \"latitude\": \"37.35983\",\n \"longitude\": \"-121.98144\",\n \"is_eu\": false,\n \"country_flag\": \"https://ipgeolocation.io/static/flags/us_64.png\",\n \"geoname_id\": \"5346804\",\n \"country_emoji\": \"🇺🇸\"\n },\n \"country_metadata\": {\n \"calling_code\": \"+1\",\n \"tld\": \".us\",\n \"languages\": [\n \"en-US\",\n \"es-US\",\n \"haw\",\n \"fr\"\n ]\n },\n \"currency\": {\n \"code\": \"USD\",\n \"name\": \"US Dollar\",\n \"symbol\": \"$\"\n },\n \"asn\": {\n \"as_number\": \"AS14061\",\n \"organization\": \"DigitalOcean, LLC\",\n \"country\": \"US\"\n },\n \"time_zone\": {\n \"name\": \"America/Los_Angeles\",\n \"offset\": -8,\n \"offset_with_dst\": -8,\n \"current_time\": \"2026-02-09 09:54:51.206-0800\",\n \"current_time_unix\": 1770659691.206,\n \"current_tz_abbreviation\": \"PST\",\n \"current_tz_full_name\": \"Pacific Standard Time\",\n \"standard_tz_abbreviation\": \"PST\",\n \"standard_tz_full_name\": \"Pacific Standard Time\",\n \"is_dst\": false,\n \"dst_savings\": 0,\n \"dst_exists\": true,\n \"dst_tz_abbreviation\": \"PDT\",\n \"dst_tz_full_name\": \"Pacific Daylight Time\",\n \"dst_start\": {\n \"utc_time\": \"2026-03-08 TIME 10:00\",\n \"duration\": \"+1.00H\",\n \"gap\": true,\n \"date_time_after\": \"2026-03-08 TIME 03:00\",\n \"date_time_before\": \"2026-03-08 TIME 02:00\",\n \"overlap\": false\n },\n \"dst_end\": {\n \"utc_time\": \"2026-11-01 TIME 09:00\",\n \"duration\": \"-1.00H\",\n \"gap\": false,\n \"date_time_after\": \"2026-11-01 TIME 01:00\",\n \"date_time_before\": \"2026-11-01 TIME 02:00\",\n \"overlap\": true\n }\n }\n}"
},
{
"name": "400 Bad Request – Invalid IP or parameter",
"originalRequest": {},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Provided name, service or IP address 'not_an_ip' is not valid.\"\n}"
},
{
"name": "401 Unauthorized – Invalid or missing API key",
"originalRequest": {},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Provided API key is not valid. Contact technical support for assistance at support@ipgeolocation.io\"\n}"
},
{
"name": "401 Unauthorized – Free plan restriction",
"originalRequest": {},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"This feature is not supported on your subscription. This feature is available on Paid subscriptions only.\"\n}"
},
{
"name": "404 Not found– Not in our Database",
"originalRequest": {},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Provided IPv4 or IPv6 address does not exist in our database.\"\n}"
},
{
"name": "405 Method Not Allowed – Post used on single endpoint",
"originalRequest": {},
"status": "Method Not Allowed",
"code": 405,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Request method 'POST' is not supported\"\n}"
},
{
"name": "423 Locked – Invalid IP range",
"originalRequest": {},
"status": "Locked",
"code": 423,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"'10.0.0.1' is a bogon IP address.\"\n}"
},
{
"name": "429 Too Many Requests – Rate limit hit",
"originalRequest": {},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"You have exceeded the limit of PLAN_USAGE_LIMIT requests per PLAN_INERVAL for your subscribed PLAN plan. Please throttle your requests or upgrade your plan to continue using IPGeolocation API without interruption.\"\n}"
},
{
"name": "499 Client Closed Request",
"originalRequest": {},
"status": "Client Closed Request",
"code": 499,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Client closed the request before the server could respond.\"\n}"
},
{
"name": "500 Internal Server Error",
"originalRequest": {},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Something went wrong on the server side.\"\n}"
}
]
},
{
"name": "Bulk IP Geolocation Lookup",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "https://api.ipgeolocation.io/v3/ipgeo-bulk",
"protocol": "https",
"host": [
"api",
"ipgeolocation",
"io"
],
"path": [
"v3",
"ipgeo-bulk"
],
"query": [
{
"key": "lang",
"value": "en",
"description": "Language code for translated location names. Defaults to `en`. Non-English responses require a paid plan. Free plans always receive English regardless of this parameter. Unsupported `lang` values return HTTP 400. Language code. Supported values: `en`, `de`, `ru`, `ja`, `fr`, `cn`, `es`, `cs`, `it`, `ko`, `fa`, `pt`. Defaults to `en`.",
"disabled": true
},
{
"key": "include",
"value": "security",
"description": "Comma-separated list of optional data modules to add to the response. These are not returned by default. Requires a paid plan. If multiple hostname options are passed in `include`, hostname resolution uses this precedence order: `liveHostname` first, then `hostname`, then `hostnameFallbackLive`. If none is specified, the `hostname` field is not returned. For `user_agent`, the API parses the `User-Agent` header from the request. For server-side calls, forward your visitor's User-Agent string in the header so the parsed result matches the actual visitor. For additional query parameters (`include`, `fields`, `excludes`, `output`), unknown values are ignored. The API still returns HTTP 200 and applies only recognized values. Free plan behavior for `include=*`: the API returns HTTP 200 and ignores the include request, returning only base response fields. In contrast, specific include values such as `include=security` return HTTP 401 on free plans.",
"disabled": true
},
{
"key": "fields",
"value": "location.city,security.threat_score,security.is_vpn",
"description": "Comma-separated list of fields or objects to return. Everything else is omitted. The `ip` field is always returned regardless of this filter. Supports dot-notation for nested fields: `location.city`, `asn.organization`. To return an entire object, use the object key: `location`, `security`. If a field belongs to an optional module (e.g. `security.threat_score`), you must also pass the corresponding `include` value. If you omit `include`, the request still succeeds, but fields from optional modules are not returned. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If the same field or object is specified in `include`, `fields`, and `excludes`, `include` takes priority over both `fields` and `excludes`. If you list both an object key and one of its nested fields separated by comma (e.g. `security,security.threat_score`), the full object is returned. Unknown field paths are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "excludes",
"value": "location.continent_code,currency,company.type",
"description": "Comma-separated list of fields or objects to remove from the response. The `ip` field cannot be excluded. Supports dot-notation for nested fields: `location.continent_code`. To exclude an entire object, use the object key: `currency`, `time_zone`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If the same field or object is specified in `include`, `fields`, and `excludes`, `include` takes priority over both `fields` and `excludes`. Unknown fields or object keys in `excludes` are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "output",
"value": "json",
"description": "Desired response format. Defaults to `json` if not specified. You can also control the format using the `Accept` header (`application/json`, `application/xml`, or `text/xml`). If both are provided, the `output` parameter takes precedence. If `output` is unknown or unsupported, it is ignored and the response defaults to JSON (`application/json`) with HTTP 200. Supported values: `json`, `xml`. Defaults to `json`.",
"disabled": true
}
]
},
"description": "Returns geolocation and enrichment data for up to 50,000 IPv4 addresses, IPv6\naddresses, or domain names in a single request. The request body must be a JSON\nobject with an `ips` array.\n\nThis endpoint requires a paid plan. Calling it with a free\nplan API key returns HTTP 401.\n\nThe response is a JSON array with one element per IP in the request. Each element\nis either a full geolocation response object or an error object with only a\n`message` field. Invalid, bogon, and unresolvable entries appear as error\nobjects. Invalid, private, and bogon IPs are not billed.\n\nThis endpoint supports the same query parameters as the single lookup endpoint,\nincluding `lang`, `include`, `fields`, `excludes`, and `output`.\n\nCredits are calculated as: credits per lookup multiplied by the number of valid\nIPs in the request. The total is returned in the `X-Credits-Charged` response\nheader. When at least one submitted ip is invalid, the `X-Successful-Record`\nresponse header indicates how many entries were successfully resolved.\n\nOnly the `POST` method is accepted. Sending a `GET` request returns HTTP 405.",
"body": {
"mode": "raw",
"raw": "{\n \"ips\": [\n \"8.8.8.8\",\n \"91.128.103.196\",\n \"2607:fb91:16c6:8860:e531:2d1d:4944:6c7c\",\n \"ipgeolocation.io\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "200 OK – Bulk response with one valid and one error entry",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "https://api.ipgeolocation.io/v3/ipgeo-bulk",
"protocol": "https",
"host": [
"api",
"ipgeolocation",
"io"
],
"path": [
"v3",
"ipgeo-bulk"
],
"query": [
{
"key": "lang",
"value": "en",
"description": "Language code for translated location names. Defaults to `en`. Non-English responses require a paid plan. Free plans always receive English regardless of this parameter. Unsupported `lang` values return HTTP 400. Language code. Supported values: `en`, `de`, `ru`, `ja`, `fr`, `cn`, `es`, `cs`, `it`, `ko`, `fa`, `pt`. Defaults to `en`.",
"disabled": true
},
{
"key": "include",
"value": "*",
"description": "Comma-separated list of optional data modules to add to the response. These are not returned by default. Requires a paid plan. If multiple hostname options are passed in `include`, hostname resolution uses this precedence order: `liveHostname` first, then `hostname`, then `hostnameFallbackLive`. If none is specified, the `hostname` field is not returned. For `user_agent`, the API parses the `User-Agent` header from the request. For server-side calls, forward your visitor's User-Agent string in the header so the parsed result matches the actual visitor. For additional query parameters (`include`, `fields`, `excludes`, `output`), unknown values are ignored. The API still returns HTTP 200 and applies only recognized values. Free plan behavior for `include=*`: the API returns HTTP 200 and ignores the include request, returning only base response fields. In contrast, specific include values such as `include=security` return HTTP 401 on free plans.",
"disabled": true
},
{
"key": "fields",
"value": "location.city,security.threat_score,security.is_vpn",
"description": "Comma-separated list of fields or objects to return. Everything else is omitted. The `ip` field is always returned regardless of this filter. Supports dot-notation for nested fields: `location.city`, `asn.organization`. To return an entire object, use the object key: `location`, `security`. If a field belongs to an optional module (e.g. `security.threat_score`), you must also pass the corresponding `include` value. If you omit `include`, the request still succeeds, but fields from optional modules are not returned. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If the same field or object is specified in `include`, `fields`, and `excludes`, `include` takes priority over both `fields` and `excludes`. If you list both an object key and one of its nested fields separated by comma (e.g. `security,security.threat_score`), the full object is returned. Unknown field paths are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "excludes",
"value": "location.continent_code,currency,company.type",
"description": "Comma-separated list of fields or objects to remove from the response. The `ip` field cannot be excluded. Supports dot-notation for nested fields: `location.continent_code`. To exclude an entire object, use the object key: `currency`, `time_zone`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If the same field or object is specified in `include`, `fields`, and `excludes`, `include` takes priority over both `fields` and `excludes`. Unknown fields or object keys in `excludes` are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "output",
"value": "json",
"description": "Desired response format. Defaults to `json` if not specified. You can also control the format using the `Accept` header (`application/json`, `application/xml`, or `text/xml`). If both are provided, the `output` parameter takes precedence. If `output` is unknown or unsupported, it is ignored and the response defaults to JSON (`application/json`) with HTTP 200. Supported values: `json`, `xml`. Defaults to `json`.",
"disabled": true
}
]
},
"body": {
"mode": "raw",
"raw": "{\n \"ips\": [\n \"8.8.8.8\",\n \"10.0.0.1\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Credits-Charged",
"value": "1"
}
],
"body": "[\n {\n \"ip\": \"8.8.8.8\",\n \"location\": {\n \"continent_code\": \"NA\",\n \"continent_name\": \"North America\",\n \"country_code2\": \"US\",\n \"country_code3\": \"USA\",\n \"country_name\": \"United States\",\n \"country_name_official\": \"United States of America\",\n \"country_capital\": \"Washington, D.C.\",\n \"state_prov\": \"California\",\n \"state_code\": \"US-CA\",\n \"district\": \"Santa Clara County\",\n \"city\": \"Mountain View\",\n \"zipcode\": \"94043\",\n \"latitude\": \"37.42240\",\n \"longitude\": \"-122.08421\",\n \"is_eu\": false,\n \"country_flag\": \"https://ipgeolocation.io/static/flags/us_64.png\",\n \"geoname_id\": \"5375480\",\n \"country_emoji\": \"🇺🇸\"\n },\n \"country_metadata\": {\n \"calling_code\": \"+1\",\n \"tld\": \".us\",\n \"languages\": [\n \"en-US\",\n \"es-US\",\n \"haw\",\n \"fr\"\n ]\n },\n \"network\": {\n \"connection_type\": \"\",\n \"route\": \"8.8.8.0/24\",\n \"is_anycast\": true\n },\n \"currency\": {\n \"code\": \"USD\",\n \"name\": \"US Dollar\",\n \"symbol\": \"$\"\n },\n \"asn\": {\n \"as_number\": \"AS15169\",\n \"organization\": \"Google LLC\",\n \"country\": \"US\",\n \"type\": \"BUSINESS\",\n \"domain\": \"google.com\",\n \"date_allocated\": \"2000-03-30\",\n \"rir\": \"ARIN\"\n },\n \"company\": {\n \"name\": \"Google LLC\",\n \"type\": \"HOSTING\",\n \"domain\": \"google.com\"\n },\n \"time_zone\": {\n \"name\": \"America/Los_Angeles\",\n \"offset\": -8,\n \"offset_with_dst\": -8,\n \"current_time\": \"2026-02-09 09:54:51.206-0800\",\n \"current_time_unix\": 1770659691.206,\n \"current_tz_abbreviation\": \"PST\",\n \"current_tz_full_name\": \"Pacific Standard Time\",\n \"standard_tz_abbreviation\": \"PST\",\n \"standard_tz_full_name\": \"Pacific Standard Time\",\n \"is_dst\": false,\n \"dst_savings\": 0,\n \"dst_exists\": true,\n \"dst_tz_abbreviation\": \"PDT\",\n \"dst_tz_full_name\": \"Pacific Daylight Time\",\n \"dst_start\": {\n \"utc_time\": \"2026-03-08 TIME 10:00\",\n \"duration\": \"+1.00H\",\n \"gap\": true,\n \"date_time_after\": \"2026-03-08 TIME 03:00\",\n \"date_time_before\": \"2026-03-08 TIME 02:00\",\n \"overlap\": false\n },\n \"dst_end\": {\n \"utc_time\": \"2026-11-01 TIME 09:00\",\n \"duration\": \"-1.00H\",\n \"gap\": false,\n \"date_time_after\": \"2026-11-01 TIME 01:00\",\n \"date_time_before\": \"2026-11-01 TIME 02:00\",\n \"overlap\": true\n }\n }\n },\n {\n \"message\": \"'10.0.0.1' is a bogon IP address.\"\n }\n]"
},
{
"name": "400 Bad Request – Invalid IP or parameter",
"originalRequest": {},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Provided name, service or IP address 'not_an_ip' is not valid.\"\n}"
},
{
"name": "400 Bad Request – Empty array",
"originalRequest": {},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"'ips' must not be empty or null\"\n}"
},
{
"name": "400 Bad Request – Exceeded 50,000 entries",
"originalRequest": {},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"No. of lookup queries cannot be more than 50000\"\n}"
},
{
"name": "401 Unauthorized – Invalid or missing API key",
"originalRequest": {},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Provided API key is not valid. Contact technical support for assistance at support@ipgeolocation.io\"\n}"
},
{
"name": "401 Unauthorized – Free plan restriction",
"originalRequest": {},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Bulk IP to geolocation lookup is not supported on your current subscription. This feature is available to all paid subscriptions only.\"\n}"
},
{
"name": "405 Method Not Allowed – GET used on bulk endpoint",
"originalRequest": {},
"status": "Method Not Allowed",
"code": 405,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Request method 'GET' is not supported\"\n}"
},
{
"name": "413 Payload Too Large – Returned by nginx",
"originalRequest": {},
"status": "Payload Too Large",
"code": 413,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"413 Request Entity Too Large\"\n}"
},
{
"name": "415 Unsupported Media Type – `Content-Type` not correct",
"originalRequest": {},
"status": "Unsupported Media Type",
"code": 415,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Content-Type 'application/x-www-form-urlencoded' is not supported\"\n}"
},
{
"name": "429 Too Many Requests – Rate limit hit",
"originalRequest": {},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"You have exceeded the limit of PLAN_USAGE_LIMIT requests per PLAN_INERVAL for your subscribed PLAN plan. Please throttle your requests or upgrade your plan to continue using IPGeolocation API without interruption.\"\n}"
},
{
"name": "499 Client Closed Request",
"originalRequest": {},
"status": "Client Closed Request",
"code": 499,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Client closed the request before the server could respond.\"\n}"
},
{
"name": "500 Internal Server Error",
"originalRequest": {},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Something went wrong on the server side.\"\n}"
}
]
}
]
},
{
"name": "IP Security API",
"description": "IP security intelligence endpoints used to detect VPNs,\nproxies, Tor exit nodes, relay networks, bot activity,\nspam activity, cloud providers, and other anonymization\ntechnologies associated with IP addresses.\n\nThe single lookup endpoint (`GET /v3/security`) analyzes\none IP per request.\n\nThe bulk lookup endpoint (`POST /v3/security-bulk`)\naccepts up to 50,000 IP addresses per request.",
"item": [
{
"name": "Single IP Security Lookup",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.ipgeolocation.io/v3/security",
"protocol": "https",
"host": [
"api",
"ipgeolocation",
"io"
],
"path": [
"v3",
"security"
],
"query": [
{
"key": "ip",
"value": "8.8.8.8",
"description": "An IPv4 address or IPv6 address to look up. When omitted, the API resolves the public IP of the requesting client. Empty or whitespace-only values are treated the same as omission and resolve caller IP. Pass `ip` only once. If multiple `ip` query parameters are sent, values may be merged and treated as invalid input (HTTP 400).",
"disabled": true
},
{
"key": "fields",
"value": "security.is_tor,security.is_vpn",
"description": "Comma-separated list of fields or objects to return. Everything else is omitted. The `ip` field is always returned regardless of this filter. Supports dot-notation for nested fields: `security.is_tor`, `security.threat_score`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If you list both an object key and one of its nested fields separated by comma (e.g. `security,security.is_vpn`), the full object is returned. Unknown field paths are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "excludes",
"value": "security.proxy_provider_names,security.is_residential_proxy",
"description": "Comma-separated list of fields or objects to remove from the response. The `ip` field cannot be excluded. Supports dot-notation for nested fields: `security.is_relay`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. Unknown fields or object keys in `excludes` are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "output",
"value": "json",
"description": "Desired response format. Defaults to `json` if not specified. You can also control the format using the `Accept` header (`application/json`, `application/xml`, or `text/xml`). If both are provided, the `output` parameter takes precedence. If `output` is unknown or unsupported, it is ignored and the response defaults to JSON (`application/json`) with HTTP 200. Supported values: `json`, `xml`. Defaults to `json`.",
"disabled": true
}
]
},
"description": "Returns threat intelligence and anonymization signals for a single\nIPv4 or IPv6 address.\n\nIf the `ip` parameter is omitted, the API automatically detects the\ncaller's public IP address and returns its security risk signals.\n\nThe response includes a threat score and multiple indicators such\nas VPN usage, proxy usage, Tor exit node detection, relay networks,\nbot activity, spam activity, and cloud hosting infrastructure.\n\nWhen available, provider names, confidence scores, and last-seen\ntimestamps are included.\n\nUse the `fields` and `excludes` parameters to control which parts\nof the response are returned."
},
"response": [
{
"name": "200 OK – Success",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.ipgeolocation.io/v3/security",
"protocol": "https",
"host": [
"api",
"ipgeolocation",
"io"
],
"path": [
"v3",
"security"
],
"query": [
{
"key": "ip",
"value": "2.56.188.34",
"description": "An IPv4 address or IPv6 address to look up. When omitted, the API resolves the public IP of the requesting client. Empty or whitespace-only values are treated the same as omission and resolve caller IP. Pass `ip` only once. If multiple `ip` query parameters are sent, values may be merged and treated as invalid input (HTTP 400).",
"disabled": false
},
{
"key": "fields",
"value": "security.is_tor,security.is_vpn",
"description": "Comma-separated list of fields or objects to return. Everything else is omitted. The `ip` field is always returned regardless of this filter. Supports dot-notation for nested fields: `security.is_tor`, `security.threat_score`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If you list both an object key and one of its nested fields separated by comma (e.g. `security,security.is_vpn`), the full object is returned. Unknown field paths are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "excludes",
"value": "security.proxy_provider_names,security.is_residential_proxy",
"description": "Comma-separated list of fields or objects to remove from the response. The `ip` field cannot be excluded. Supports dot-notation for nested fields: `security.is_relay`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. Unknown fields or object keys in `excludes` are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "output",
"value": "json",
"description": "Desired response format. Defaults to `json` if not specified. You can also control the format using the `Accept` header (`application/json`, `application/xml`, or `text/xml`). If both are provided, the `output` parameter takes precedence. If `output` is unknown or unsupported, it is ignored and the response defaults to JSON (`application/json`) with HTTP 200. Supported values: `json`, `xml`. Defaults to `json`.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Credits-Charged",
"value": "1"
}
],
"body": "{\n \"ip\": \"2.56.188.34\",\n \"security\": {\n \"threat_score\": 80,\n \"is_tor\": false,\n \"is_proxy\": true,\n \"proxy_provider_names\": [\n \"Zyte Proxy\"\n ],\n \"proxy_confidence_score\": 80,\n \"proxy_last_seen\": \"2025-12-12\",\n \"is_residential_proxy\": true,\n \"is_vpn\": true,\n \"vpn_provider_names\": [\n \"Nord VPN\"\n ],\n \"vpn_confidence_score\": 80,\n \"vpn_last_seen\": \"2026-01-19\",\n \"is_relay\": false,\n \"relay_provider_name\": \"\",\n \"is_anonymous\": true,\n \"is_known_attacker\": true,\n \"is_bot\": false,\n \"is_spam\": false,\n \"is_cloud_provider\": true,\n \"cloud_provider_name\": \"Packethub S.A.\"\n }\n}"
},
{
"name": "400 Bad Request – Invalid IP or parameter",
"originalRequest": {},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Provided name, service or IP address 'not_an_ip' is not valid.\"\n}"
},
{
"name": "401 Unauthorized – Invalid or missing API key",
"originalRequest": {},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Provided API key is not valid. Contact technical support for assistance at support@ipgeolocation.io.\"\n}"
},
{
"name": "401 Unauthorized – Free plan restriction",
"originalRequest": {},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"IP Security API is not supported on your current subscription. This feature is available on paid subscriptions only.\"\n}"
},
{
"name": "404 Not found– Not in our Database",
"originalRequest": {},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Provided IPv4 or IPv6 address does not exist in our database.\"\n}"
},
{
"name": "405 Method Not Allowed – Post used on single endpoint",
"originalRequest": {},
"status": "Method Not Allowed",
"code": 405,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Request method 'POST' is not supported\"\n}"
},
{
"name": "423 Locked – Invalid IP range",
"originalRequest": {},
"status": "Locked",
"code": 423,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"'10.0.0.1' is a bogon IP address.\"\n}"
},
{
"name": "429 Too Many Requests – Rate limit hit",
"originalRequest": {},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"You have exceeded the limit of PLAN_USAGE_LIMIT requests per PLAN_INERVAL for your subscribed PLAN plan. Please throttle your requests or upgrade your plan to continue using IPGeolocation API without interruption.\"\n}"
},
{
"name": "499 Client Closed Request",
"originalRequest": {},
"status": "Client Closed Request",
"code": 499,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Client closed the request before the server could respond.\"\n}"
},
{
"name": "500 Internal Server Error",
"originalRequest": {},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"message\": \"Something went wrong on the server side.\"\n}"
}
]
},
{
"name": "Bulk IP Security Lookup",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "https://api.ipgeolocation.io/v3/security-bulk",
"protocol": "https",
"host": [
"api",
"ipgeolocation",
"io"
],
"path": [
"v3",
"security-bulk"
],
"query": [
{
"key": "fields",
"value": "security.is_tor,security.is_vpn",
"description": "Comma-separated list of fields or objects to return. Everything else is omitted. The `ip` field is always returned regardless of this filter. Supports dot-notation for nested fields: `security.is_tor`, `security.threat_score`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. If you list both an object key and one of its nested fields separated by comma (e.g. `security,security.is_vpn`), the full object is returned. Unknown field paths are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "excludes",
"value": "security.proxy_provider_names,security.is_residential_proxy",
"description": "Comma-separated list of fields or objects to remove from the response. The `ip` field cannot be excluded. Supports dot-notation for nested fields: `security.is_relay`. If the same field or object is specified in both `fields` and `excludes`, the object is still returned, but it will be empty. Unknown fields or object keys in `excludes` are ignored. The API still returns HTTP 200. Available on all plans including Free.",
"disabled": true
},
{
"key": "output",
"value": "json",
"description": "Desired response format. Defaults to `json` if not specified. You can also control the format using the `Accept` header (`application/json`, `application/xml`, or `text/xml`). If both are provided, the `output` parameter takes precedence. If `output` is unknown or unsupported, it is ignored and the response defaults to JSON (`application/json`) with HTTP 200. Supported values: `json`, `xml`. Defaults to `json`.",
"disabled": true
}
]
},
"description": "Returns security intelligence for up to **50,000 IPv4 or IPv6\naddresses** in a single request.\n\nThe request body must contain an `ips` array.\n\nEach IP is processed independently. Invalid, bogon, or private\nIP addresses return an object containing only a `message` field.\n\nCredits are charged **per valid IP address** using the same\npricing rules as the single lookup endpoint.\n\nWhen at least one entry is invalid, the response header\n`X-Successful-Record` indicates the number of successful\nlookups.\n\nOnly the `POST` method is supported for this endpoint.",
"body": {
"mode": "raw",
"raw": "{\n \"ips\": [\n \"8.8.8.8\",\n \"91.128.103.196\",\n \"2607:fb91:16c6:8860:e531:2d1d:4944:6c7c\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "200 OK – Success",
"originalRequest": {
"method": "POST",
"header": [