@apifreaks/openapi-specs 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/dist/index.cjs +131 -0
  2. package/dist/index.d.cts +140 -3
  3. package/dist/index.d.ts +140 -3
  4. package/dist/index.js +129 -0
  5. package/dist/specs/commodity/commodity-fluctuation.yaml +225 -0
  6. package/dist/specs/commodity/commodity-prices.yaml +236 -0
  7. package/dist/specs/commodity/commodity-symbols.yaml +159 -0
  8. package/dist/specs/commodity/commodity-time-series.yaml +238 -0
  9. package/dist/specs/commodity/historical-commodity-prices.yaml +208 -0
  10. package/dist/specs/currency/currency-converter.yaml +193 -0
  11. package/dist/specs/currency/currency-fluctuation.yaml +211 -0
  12. package/dist/specs/currency/currency-historical-data-limit.yaml +112 -0
  13. package/dist/specs/currency/currency-rate.yaml +173 -0
  14. package/dist/specs/currency/currency-supported.yaml +176 -0
  15. package/dist/specs/currency/currency-symbols.yaml +115 -0
  16. package/dist/specs/currency/currency-time-series.yaml +232 -0
  17. package/dist/specs/currency/geolocalized-currency-conversion.yaml +214 -0
  18. package/dist/specs/currency/historical-currency-converter.yaml +195 -0
  19. package/dist/specs/currency/historical-currency-rate.yaml +180 -0
  20. package/dist/specs/dns/bulk-dns-lookup.yaml +484 -0
  21. package/dist/specs/dns/dns-history-lookup.yaml +451 -0
  22. package/dist/specs/dns/dns-lookup.yaml +360 -0
  23. package/dist/specs/dns/reverse-dns-lookup.yaml +338 -0
  24. package/dist/specs/domain/bulk-domain-checker.yaml +198 -0
  25. package/dist/specs/domain/domain-search-with-suggestions.yaml +196 -0
  26. package/dist/specs/domain/domain-search.yaml +149 -0
  27. package/dist/specs/domain/subdomain-lookup.yaml +251 -0
  28. package/dist/specs/email-validation/bulk-email-validation.yaml +403 -0
  29. package/dist/specs/email-validation/email-checker.yaml +451 -0
  30. package/dist/specs/financial/bulk-vat-rates-country.yaml +250 -0
  31. package/dist/specs/financial/financial-apis-supported-countries.yaml +152 -0
  32. package/dist/specs/financial/iban-validation.yaml +270 -0
  33. package/dist/specs/financial/swift-code-finder.yaml +146 -0
  34. package/dist/specs/financial/swift-code-lookup.yaml +156 -0
  35. package/dist/specs/financial/vat-number-validation.yaml +205 -0
  36. package/dist/specs/financial/vat-rates-by-ip.yaml +200 -0
  37. package/dist/specs/financial/vat-rates-country.yaml +212 -0
  38. package/dist/specs/general/usage-credits.yaml +188 -0
  39. package/dist/specs/geocoding/forward-geocoding.yaml +292 -0
  40. package/dist/specs/geocoding/reverse-geocoding.yaml +237 -0
  41. package/dist/specs/geodb/administrative-units-details.yaml +180 -0
  42. package/dist/specs/geodb/administrative-units-levels.yaml +140 -0
  43. package/dist/specs/geodb/administrative-units.yaml +168 -0
  44. package/dist/specs/geodb/cities.yaml +209 -0
  45. package/dist/specs/geodb/countries-details.yaml +207 -0
  46. package/dist/specs/geodb/countries.yaml +199 -0
  47. package/dist/specs/geodb/flags-supported.yaml +119 -0
  48. package/dist/specs/geodb/flags.yaml +170 -0
  49. package/dist/specs/geodb/regions.yaml +76 -0
  50. package/dist/specs/geodb/subregions.yaml +158 -0
  51. package/dist/specs/ip-intelligence/bulk-ip-lookup.yaml +895 -0
  52. package/dist/specs/ip-intelligence/bulk-ip-threat-intelligence.yaml +310 -0
  53. package/dist/specs/ip-intelligence/ip-locator.yaml +708 -0
  54. package/dist/specs/ip-intelligence/ip-threat-intelligence.yaml +230 -0
  55. package/dist/specs/other/astronomy-data.yaml +632 -0
  56. package/dist/specs/pdf/delete-pdf-page.yaml +193 -0
  57. package/dist/specs/pdf/linearize-pdf.yaml +187 -0
  58. package/dist/specs/pdf/merge-pdf.yaml +193 -0
  59. package/dist/specs/pdf/pdf-compress.yaml +208 -0
  60. package/dist/specs/pdf/pdf-decrypt.yaml +202 -0
  61. package/dist/specs/pdf/pdf-encrypt.yaml +213 -0
  62. package/dist/specs/pdf/pdf-extract-pages.yaml +199 -0
  63. package/dist/specs/pdf/pdf-file-status.yaml +148 -0
  64. package/dist/specs/pdf/pdf-file.yaml +136 -0
  65. package/dist/specs/pdf/pdf-files.yaml +85 -0
  66. package/dist/specs/pdf/pdf-resource-download.yaml +117 -0
  67. package/dist/specs/pdf/pdf-resource-upload-binary.yaml +152 -0
  68. package/dist/specs/pdf/pdf-resource-upload.yaml +163 -0
  69. package/dist/specs/pdf/pdf-restrict.yaml +246 -0
  70. package/dist/specs/pdf/pdf-split-pages.yaml +208 -0
  71. package/dist/specs/pdf/pdf-task-status.yaml +187 -0
  72. package/dist/specs/pdf/pdf-to-image.yaml +844 -0
  73. package/dist/specs/pdf/pdf-unrestrict.yaml +221 -0
  74. package/dist/specs/pdf/rotate-pdf-pages.yaml +207 -0
  75. package/dist/specs/phone-validation/bulk-phone-number-validation.yaml +374 -0
  76. package/dist/specs/phone-validation/phone-number-validation.yaml +344 -0
  77. package/dist/specs/scraper/web-scraper.yaml +479 -0
  78. package/dist/specs/screenshot/bulk-screenshot.yaml +728 -0
  79. package/dist/specs/screenshot/website-screenshot.yaml +822 -0
  80. package/dist/specs/ssl/ssl-certificate-chain-lookup.yaml +593 -0
  81. package/dist/specs/ssl/ssl-certificate-lookup.yaml +478 -0
  82. package/dist/specs/timezone/timezone-converter.yaml +249 -0
  83. package/dist/specs/timezone/timezone-lookup.yaml +712 -0
  84. package/dist/specs/user-agent/bulk-user-agent-parser.yaml +340 -0
  85. package/dist/specs/user-agent/user-agent-parser.yaml +271 -0
  86. package/dist/specs/weather/air-quality.yaml +590 -0
  87. package/dist/specs/weather/bulk-live-weather.yaml +654 -0
  88. package/dist/specs/weather/flood-forecast.yaml +519 -0
  89. package/dist/specs/weather/historical-weather.yaml +842 -0
  90. package/dist/specs/weather/live-weather.yaml +633 -0
  91. package/dist/specs/weather/marine-weather.yaml +806 -0
  92. package/dist/specs/weather/time-series-weather.yaml +821 -0
  93. package/dist/specs/weather/weather-forecast.yaml +935 -0
  94. package/dist/specs/whois/asn-lookup.yaml +618 -0
  95. package/dist/specs/whois/bulk-whois-lookup.yaml +827 -0
  96. package/dist/specs/whois/domain-whois-history-lookup.yaml +445 -0
  97. package/dist/specs/whois/reverse-whois.yaml +566 -0
  98. package/dist/specs/whois/whois-domain-lookup.yaml +537 -0
  99. package/dist/specs/whois/whois-ip-lookup.yaml +1123 -0
  100. package/dist/specs/zip-code/bulk-zip-code-lookup.yaml +232 -0
  101. package/dist/specs/zip-code/zip-code-api.yaml +216 -0
  102. package/dist/specs/zip-code/zip-code-distance-match.yaml +239 -0
  103. package/dist/specs/zip-code/zip-code-distance.yaml +233 -0
  104. package/dist/specs/zip-code/zip-codes-by-city.yaml +201 -0
  105. package/dist/specs/zip-code/zip-codes-by-region.yaml +200 -0
  106. package/dist/specs/zip-code/zip-codes-radius-search.yaml +262 -0
  107. package/package.json +6 -2
@@ -0,0 +1,1123 @@
1
+ openapi: 3.1.1
2
+ info:
3
+ title: IP WHOIS Lookup API - Organization, CIDR & Abuse Contact Data
4
+ version: 1.0.0
5
+ description: Retrieve WHOIS registration and ownership data for any IPv4 or IPv6 address from the appropriate Regional Internet Registry (ARIN, RIPE NCC, APNIC, LACNIC, or AFRINIC). Returns the IP range (inet_num) with CIDR blocks, net name, allocation status, and parent blocks; the registering organization with full address and contact handles; technical and abuse contacts with email and phone; BGP route objects; and the raw WHOIS response. The irt (IRT) object is included when available, containing the internet response team's address, abuse mailbox, and linked contacts.
6
+ contact:
7
+ name: APIFreaks Support
8
+ url: https://apifreaks.com/contact
9
+ email: support@apifreaks.com
10
+ servers:
11
+ - url: https://api.apifreaks.com/v1.0
12
+ description: IP WHOIS Lookup API Server
13
+ paths:
14
+ /ip/whois/live:
15
+ get:
16
+ tags:
17
+ - WHOIS APIs
18
+ summary: Retrieve WHOIS registration and ownership data for an IP address
19
+ description: Returns WHOIS details for an IPv4 or IPv6 address including IP range, organization, contacts, routes, and raw WHOIS output.
20
+ operationId: lookupIpWhois
21
+ parameters:
22
+ - name: format
23
+ in: query
24
+ required: false
25
+ description: Format of the response.
26
+ schema:
27
+ type: string
28
+ enum:
29
+ - json
30
+ - xml
31
+ default: json
32
+ - name: ip
33
+ in: query
34
+ required: true
35
+ description: IPv4 or IPv6 address to look up.
36
+ schema:
37
+ type: string
38
+ responses:
39
+ '200':
40
+ description: Successful WHOIS lookup response
41
+ content:
42
+ application/json:
43
+ schema:
44
+ $ref: '#/components/schemas/IpWhoisResponse'
45
+ examples:
46
+ typicalSuccess:
47
+ summary: Typical successful response
48
+ value:
49
+ status: true
50
+ ip_address: 8.8.8.8
51
+ query_time: '2026-07-23 08:23:30'
52
+ whois_server: whois.arin.net
53
+ inet_nums:
54
+ - start_ip: 8.8.8.0
55
+ end_ip: 8.8.8.255
56
+ cidr:
57
+ - 8.8.8.0/24
58
+ net_name: GOGL
59
+ net_handle: NET-8-8-8-0-2
60
+ status: Direct Allocation
61
+ organization: Google LLC (GOGL)
62
+ date_created: '2023-12-28'
63
+ date_updated: '2023-12-28'
64
+ source: https://rdap.arin.net/registry/ip/8.8.8.0
65
+ parents:
66
+ - NET8 (NET-8-0-0-0-0)
67
+ organization:
68
+ handle: GOGL
69
+ name: Google LLC
70
+ address:
71
+ - 1600 Amphitheatre Parkway
72
+ - Mountain View
73
+ - CA
74
+ - '94043'
75
+ - US
76
+ street: Amphitheatre Parkway
77
+ city: Mountain View
78
+ state: CA
79
+ zip_code: '94043'
80
+ country:
81
+ - US
82
+ date_created: '2000-03-30'
83
+ date_updated: '2019-10-31'
84
+ source: https://rdap.arin.net/registry/entity/GOGL
85
+ technical_contacts:
86
+ - handle: ZG39-ARIN
87
+ name: Google LLC
88
+ email:
89
+ - arin-contact@google.com
90
+ phone:
91
+ - +1-650-253-0000
92
+ source: https://rdap.arin.net/registry/entity/ZG39-ARIN
93
+ abuse_contacts:
94
+ - handle: ABUSE5250-ARIN
95
+ name: Abuse
96
+ email:
97
+ - network-abuse@google.com
98
+ phone:
99
+ - +1-650-253-0000
100
+ source: https://rdap.arin.net/registry/entity/ABUSE5250-ARIN
101
+ routes:
102
+ - source: https://rdap.arin.net/registry/ip/8.8.8.0
103
+ whois_raw_response: |
104
+
105
+ #
106
+ # ARIN WHOIS data and services are subject to the Terms of Use
107
+ # available at: https://www.arin.net/resources/registry/whois/tou/
108
+ #
109
+ # If you see inaccuracies in the results, please report at
110
+ # https://www.arin.net/resources/registry/whois/inaccuracy_reporting/
111
+ #
112
+ # Copyright 1997-2026, American Registry for Internet Numbers, Ltd.
113
+ #
114
+
115
+
116
+ NetRange: 8.8.8.0 - 8.8.8.255
117
+ CIDR: 8.8.8.0/24
118
+ NetName: GOGL
119
+ NetHandle: NET-8-8-8-0-2
120
+ Parent: NET8 (NET-8-0-0-0-0)
121
+ NetType: Direct Allocation
122
+ OriginAS:
123
+ Organization: Google LLC (GOGL)
124
+ RegDate: 2023-12-28
125
+ Updated: 2023-12-28
126
+ Ref: https://rdap.arin.net/registry/ip/8.8.8.0
127
+
128
+
129
+
130
+ OrgName: Google LLC
131
+ OrgId: GOGL
132
+ Address: 1600 Amphitheatre Parkway
133
+ City: Mountain View
134
+ StateProv: CA
135
+ PostalCode: 94043
136
+ Country: US
137
+ RegDate: 2000-03-30
138
+ Updated: 2019-10-31
139
+ Comment: Please note that the recommended way to file abuse complaints are located in the following links.
140
+ Comment:
141
+ Comment: To report abuse and illegal activity: https://www.google.com/contact/
142
+ Comment:
143
+ Comment: For legal requests: http://support.google.com/legal
144
+ Comment:
145
+ Comment: Regards,
146
+ Comment: The Google Team
147
+ Ref: https://rdap.arin.net/registry/entity/GOGL
148
+
149
+
150
+ OrgAbuseHandle: ABUSE5250-ARIN
151
+ OrgAbuseName: Abuse
152
+ OrgAbusePhone: +1-650-253-0000
153
+ OrgAbuseEmail: network-abuse@google.com
154
+ OrgAbuseRef: https://rdap.arin.net/registry/entity/ABUSE5250-ARIN
155
+
156
+ OrgTechHandle: ZG39-ARIN
157
+ OrgTechName: Google LLC
158
+ OrgTechPhone: +1-650-253-0000
159
+ OrgTechEmail: arin-contact@google.com
160
+ OrgTechRef: https://rdap.arin.net/registry/entity/ZG39-ARIN
161
+
162
+
163
+ #
164
+ # ARIN WHOIS data and services are subject to the Terms of Use
165
+ # available at: https://www.arin.net/resources/registry/whois/tou/
166
+ #
167
+ # If you see inaccuracies in the results, please report at
168
+ # https://www.arin.net/resources/registry/whois/inaccuracy_reporting/
169
+ #
170
+ # Copyright 1997-2026, American Registry for Internet Numbers, Ltd.
171
+ #
172
+ '206':
173
+ description: Partial Content -- The WHOIS server returned an incomplete response. Some fields may be missing or truncated.
174
+ content:
175
+ application/json:
176
+ schema:
177
+ $ref: '#/components/schemas/ErrorResponse'
178
+ examples:
179
+ partialResponse:
180
+ summary: Partial WHOIS response
181
+ value:
182
+ timestamp: '2025-08-14T09:25:32.271Z'
183
+ status: 206
184
+ error: Partial Response
185
+ message: Partial response due to an error occurred while processing the request.
186
+ path: /v1.0/ip/whois/live
187
+ '400':
188
+ description: Bad Request -- Missing or invalid ip parameter
189
+ content:
190
+ application/json:
191
+ schema:
192
+ $ref: '#/components/schemas/ErrorResponse'
193
+ examples:
194
+ missingIp:
195
+ summary: Missing ip parameter
196
+ value:
197
+ error: Invalid Param Exception
198
+ message: please pass correct parameters
199
+ path: /v1.0/ip/whois/live
200
+ status: 400
201
+ timestamp: '2026-07-23T07:50:28.230Z'
202
+ invalidIp:
203
+ summary: Invalid IP address format
204
+ value:
205
+ timestamp: '2026-07-23T08:03:38.179Z'
206
+ status: 400
207
+ error: Input parameter is not valid
208
+ message: Request-param 'ip' (not-an-ip) is not an IP address
209
+ path: /v1.0/ip-whois
210
+ components:
211
+ securitySchemes:
212
+ ApiKeyAuthHeader:
213
+ type: apiKey
214
+ in: header
215
+ name: X-apiKey
216
+ description: Pass your API key via the X-apiKey request header.
217
+ ApiKeyAuthQuery:
218
+ type: apiKey
219
+ in: query
220
+ name: apiKey
221
+ description: Pass your API key via the apiKey query parameter.
222
+ schemas:
223
+ ErrorResponse:
224
+ type: object
225
+ required:
226
+ - message
227
+ properties:
228
+ error:
229
+ type: string
230
+ description: Short error category or exception type.
231
+ message:
232
+ type: string
233
+ description: Human-readable error message describing the failure.
234
+ path:
235
+ type: string
236
+ description: API endpoint path that produced the error.
237
+ status:
238
+ type: integer
239
+ description: HTTP status code returned with the error.
240
+ timestamp:
241
+ type: string
242
+ format: date-time
243
+ description: Timestamp when the error occurred (ISO 8601).
244
+ IpWhoisResponse:
245
+ type: object
246
+ description: WHOIS lookup response containing IP registration data, organization, contacts, routes, and raw WHOIS output.
247
+ required:
248
+ - status
249
+ - ip_address
250
+ - query_time
251
+ - whois_server
252
+ - whois_raw_response
253
+ properties:
254
+ status:
255
+ type: boolean
256
+ description: Indicates whether the WHOIS response from the WHOIS server is complete.
257
+ ip_address:
258
+ type: string
259
+ description: IP address (IPv4 or IPv6) that was queried.
260
+ query_time:
261
+ type: string
262
+ description: Date and time of the WHOIS query in YYYY-MM-DD HH:mm:ss format.
263
+ whois_server:
264
+ type: string
265
+ description: WHOIS host server used to query the IP address.
266
+ inet_nums:
267
+ type: array
268
+ description: IP range allocations (inetnum/aut-num objects) associated with this IP address.
269
+ items:
270
+ $ref: '#/components/schemas/InetNum'
271
+ irt:
272
+ $ref: '#/components/schemas/IrtObject'
273
+ organization:
274
+ $ref: '#/components/schemas/IpWhoisOrganization'
275
+ technical_contacts:
276
+ type: array
277
+ description: Technical contact persons or roles for this IP allocation.
278
+ items:
279
+ $ref: '#/components/schemas/WhoisContactRef'
280
+ abuse_contacts:
281
+ type: array
282
+ description: Abuse contact persons or roles for reporting network abuse.
283
+ items:
284
+ $ref: '#/components/schemas/WhoisContactRef'
285
+ routes:
286
+ type: array
287
+ description: BGP route objects announced by this IP's network.
288
+ items:
289
+ $ref: '#/components/schemas/RouteObject'
290
+ whois_raw_response:
291
+ type: string
292
+ description: Unparsed WHOIS response from the WHOIS server.
293
+ r_whois_raw_response:
294
+ type:
295
+ - string
296
+ - 'null'
297
+ description: WHOIS response from the rwhois server, if available.
298
+ InetNum:
299
+ type: object
300
+ description: IP range allocation record (inetnum object) containing the allocated block, network name, status, and organizational linkage.
301
+ required:
302
+ - start_ip
303
+ - end_ip
304
+ - cidr
305
+ - net_name
306
+ - source
307
+ properties:
308
+ start_ip:
309
+ type: string
310
+ description: Starting IP address of the allocated range.
311
+ end_ip:
312
+ type: string
313
+ description: Ending IP address of the allocated range.
314
+ cidr:
315
+ type: array
316
+ description: IP range in CIDR notation.
317
+ items:
318
+ type: string
319
+ net_name:
320
+ type: string
321
+ description: Network name (unique identifier) of this inetnum in WHOIS data.
322
+ net_handle:
323
+ type:
324
+ - string
325
+ - 'null'
326
+ description: Net-Handle (unique ID) of this inetnum, primarily from ARIN responses.
327
+ description:
328
+ type:
329
+ - array
330
+ - 'null'
331
+ description: Description values from the inetnum object.
332
+ items:
333
+ type: string
334
+ countries:
335
+ type:
336
+ - array
337
+ - 'null'
338
+ description: ISO 3166-1 alpha-2 country codes where the IP block is allocated.
339
+ items:
340
+ type: string
341
+ geofeed:
342
+ type:
343
+ - string
344
+ - 'null'
345
+ description: URL to the geofeed (RFC 8805) for this prefix.
346
+ latitude:
347
+ type:
348
+ - number
349
+ - 'null'
350
+ format: float
351
+ description: Latitude parsed from the geoloc field.
352
+ longitude:
353
+ type:
354
+ - number
355
+ - 'null'
356
+ format: float
357
+ description: Longitude parsed from the geoloc field.
358
+ city:
359
+ type:
360
+ - string
361
+ - 'null'
362
+ description: City of allocation, primarily from LACNIC responses.
363
+ languages:
364
+ type:
365
+ - array
366
+ - 'null'
367
+ description: Regional languages in countries of allocation.
368
+ items:
369
+ type: string
370
+ status:
371
+ type:
372
+ - string
373
+ - 'null'
374
+ description: Allocation or assignment status (e.g., 'Direct Allocation').
375
+ organization:
376
+ type:
377
+ - string
378
+ - 'null'
379
+ description: Handle (unique ID) of the organization managing this inetnum.
380
+ sponsoring_organization:
381
+ type:
382
+ - string
383
+ - 'null'
384
+ description: Handle of the sponsoring organization for this inetnum.
385
+ admin_contacts:
386
+ type:
387
+ - array
388
+ - 'null'
389
+ description: Handles of admin persons or roles in WHOIS data.
390
+ items:
391
+ type: string
392
+ tech_contacts:
393
+ type:
394
+ - array
395
+ - 'null'
396
+ description: Handles of technical persons or roles in WHOIS data.
397
+ items:
398
+ type: string
399
+ abuse_contacts:
400
+ type:
401
+ - array
402
+ - 'null'
403
+ description: Handles of abuse persons or roles in WHOIS data.
404
+ items:
405
+ type: string
406
+ remarks:
407
+ type:
408
+ - array
409
+ - 'null'
410
+ description: Remarks from the inetnum object.
411
+ items:
412
+ type: string
413
+ assignment_size:
414
+ type:
415
+ - string
416
+ - 'null'
417
+ description: Allocation or assignment size of the IP network or block.
418
+ notify:
419
+ type:
420
+ - array
421
+ - 'null'
422
+ description: Notify email addresses from the inetnum object.
423
+ items:
424
+ type: string
425
+ mnt_by:
426
+ type:
427
+ - array
428
+ - 'null'
429
+ description: Maintainer handles from the inetnum object.
430
+ items:
431
+ type: string
432
+ mnt_lower:
433
+ type:
434
+ - array
435
+ - 'null'
436
+ description: Lower-level maintainer handles from the inetnum object.
437
+ items:
438
+ type: string
439
+ mnt_domains:
440
+ type:
441
+ - array
442
+ - 'null'
443
+ description: Domain maintainer handles from the inetnum object.
444
+ items:
445
+ type: string
446
+ mnt_routes:
447
+ type:
448
+ - array
449
+ - 'null'
450
+ description: Route maintainer handles from the inetnum object.
451
+ items:
452
+ type: string
453
+ mnt_irt:
454
+ type:
455
+ - array
456
+ - 'null'
457
+ description: IRT maintainer handles from the inetnum object.
458
+ items:
459
+ type: string
460
+ date_created:
461
+ type:
462
+ - string
463
+ - 'null'
464
+ format: date
465
+ description: Registration date of this inetnum object (YYYY-MM-DD).
466
+ date_updated:
467
+ type:
468
+ - string
469
+ - 'null'
470
+ format: date
471
+ description: Last update date of this inetnum object (YYYY-MM-DD).
472
+ source:
473
+ type: string
474
+ description: WHOIS data source (RIR registry URL) for this object.
475
+ parents:
476
+ type:
477
+ - array
478
+ - 'null'
479
+ description: Parent allocation or assignment blocks of this inetnum.
480
+ items:
481
+ type: string
482
+ IrtObject:
483
+ type: object
484
+ description: IRT (Internet Response Team) object containing the response team's address, abuse mailbox, contacts, and linked organizations.
485
+ required:
486
+ - handle
487
+ - address
488
+ - email
489
+ - abuse_mailbox
490
+ - admin_contacts
491
+ - tech_contacts
492
+ - source
493
+ properties:
494
+ handle:
495
+ type: string
496
+ description: Handle or unique identifier of this IRT in WHOIS data.
497
+ address:
498
+ type: array
499
+ description: Address lines of the IRT.
500
+ items:
501
+ type: string
502
+ street:
503
+ type:
504
+ - string
505
+ - 'null'
506
+ description: Parsed street address from the address field.
507
+ city:
508
+ type:
509
+ - string
510
+ - 'null'
511
+ description: Parsed city from the address field.
512
+ district:
513
+ type:
514
+ - string
515
+ - 'null'
516
+ description: Parsed district from the address field.
517
+ state:
518
+ type:
519
+ - string
520
+ - 'null'
521
+ description: Parsed state from the address field.
522
+ zip_code:
523
+ type:
524
+ - string
525
+ - 'null'
526
+ description: Parsed ZIP code from the address field.
527
+ country:
528
+ type:
529
+ - string
530
+ - 'null'
531
+ description: Parsed country from the address field.
532
+ email:
533
+ type: array
534
+ description: Email addresses for the IRT.
535
+ items:
536
+ type: string
537
+ abuse_mailbox:
538
+ type: array
539
+ description: Abuse mailbox email addresses for the IRT.
540
+ items:
541
+ type: string
542
+ phone:
543
+ type:
544
+ - array
545
+ - 'null'
546
+ description: Phone numbers for the IRT.
547
+ items:
548
+ type: string
549
+ fax_no:
550
+ type:
551
+ - array
552
+ - 'null'
553
+ description: Fax numbers for the IRT.
554
+ items:
555
+ type: string
556
+ organizations:
557
+ type:
558
+ - array
559
+ - 'null'
560
+ description: Handles of organization objects linked to this IRT.
561
+ items:
562
+ type: string
563
+ admin_contacts:
564
+ type: array
565
+ description: Handles of admin persons or roles linked to this IRT.
566
+ items:
567
+ type: string
568
+ tech_contacts:
569
+ type: array
570
+ description: Handles of technical persons or roles linked to this IRT.
571
+ items:
572
+ type: string
573
+ remarks:
574
+ type:
575
+ - array
576
+ - 'null'
577
+ description: Remarks for this IRT object.
578
+ items:
579
+ type: string
580
+ signature:
581
+ type:
582
+ - array
583
+ - 'null'
584
+ description: Cryptographic signatures for this IRT object.
585
+ items:
586
+ type: string
587
+ encryption:
588
+ type:
589
+ - array
590
+ - 'null'
591
+ description: Encryption keys for this IRT object.
592
+ items:
593
+ type: string
594
+ auth:
595
+ type:
596
+ - array
597
+ - 'null'
598
+ description: Authentication methods for this IRT object.
599
+ items:
600
+ type: string
601
+ notify:
602
+ type:
603
+ - array
604
+ - 'null'
605
+ description: Notify email addresses for this IRT object.
606
+ items:
607
+ type: string
608
+ irt_nfy:
609
+ type:
610
+ - array
611
+ - 'null'
612
+ description: IRT-specific notification email addresses.
613
+ items:
614
+ type: string
615
+ mnt_by:
616
+ type:
617
+ - array
618
+ - 'null'
619
+ description: Maintainer handles for this IRT object.
620
+ items:
621
+ type: string
622
+ mnt_ref:
623
+ type:
624
+ - array
625
+ - 'null'
626
+ description: Referenced maintainer handles for this IRT object.
627
+ items:
628
+ type: string
629
+ date_created:
630
+ type:
631
+ - string
632
+ - 'null'
633
+ format: date
634
+ description: Registration date of this IRT object (YYYY-MM-DD).
635
+ date_updated:
636
+ type:
637
+ - string
638
+ - 'null'
639
+ format: date
640
+ description: Last update date of this IRT object (YYYY-MM-DD).
641
+ source:
642
+ type: string
643
+ description: WHOIS data source for this IRT object.
644
+ organization:
645
+ $ref: '#/components/schemas/IpWhoisOrganization'
646
+ administrative_contacts:
647
+ type:
648
+ - array
649
+ - 'null'
650
+ description: Administrative contacts linked to this IRT.
651
+ items:
652
+ $ref: '#/components/schemas/WhoisContactRef'
653
+ technical_contacts:
654
+ type:
655
+ - array
656
+ - 'null'
657
+ description: Technical contacts linked to this IRT.
658
+ items:
659
+ $ref: '#/components/schemas/WhoisContactRef'
660
+ abuse_contacts:
661
+ type:
662
+ - array
663
+ - 'null'
664
+ description: Abuse contacts linked to this IRT.
665
+ items:
666
+ $ref: '#/components/schemas/WhoisContactRef'
667
+ IpWhoisOrganization:
668
+ type: object
669
+ description: Organization object containing the registrant's handle, name, address, contact details, and linked admin/tech/abuse contacts.
670
+ required:
671
+ - handle
672
+ - name
673
+ - source
674
+ properties:
675
+ handle:
676
+ type: string
677
+ description: Handle or unique identifier of this organization in WHOIS data.
678
+ name:
679
+ type: string
680
+ description: Name of the organization.
681
+ type:
682
+ type:
683
+ - string
684
+ - 'null'
685
+ description: Type of the organization (e.g., BUSINESS, REGISTRY).
686
+ description:
687
+ type:
688
+ - array
689
+ - 'null'
690
+ description: Description values from the organization object.
691
+ items:
692
+ type: string
693
+ address:
694
+ type:
695
+ - array
696
+ - 'null'
697
+ description: Full address lines of the organization.
698
+ items:
699
+ type: string
700
+ street:
701
+ type:
702
+ - string
703
+ - 'null'
704
+ description: Parsed street address from the address field.
705
+ city:
706
+ type:
707
+ - string
708
+ - 'null'
709
+ description: Parsed city from the address field.
710
+ district:
711
+ type:
712
+ - string
713
+ - 'null'
714
+ description: Parsed district from the address field.
715
+ state:
716
+ type:
717
+ - string
718
+ - 'null'
719
+ description: Parsed state from the address field.
720
+ zip_code:
721
+ type:
722
+ - string
723
+ - 'null'
724
+ description: Parsed ZIP code from the address field.
725
+ country:
726
+ type:
727
+ - array
728
+ - 'null'
729
+ description: ISO 3166-1 alpha-2 country codes for the organization.
730
+ items:
731
+ type: string
732
+ latitude:
733
+ type:
734
+ - number
735
+ - 'null'
736
+ format: float
737
+ description: Latitude parsed from the geoloc field.
738
+ longitude:
739
+ type:
740
+ - number
741
+ - 'null'
742
+ format: float
743
+ description: Longitude parsed from the geoloc field.
744
+ email:
745
+ type:
746
+ - array
747
+ - 'null'
748
+ description: Email addresses for the organization.
749
+ items:
750
+ type: string
751
+ abuse_mailbox:
752
+ type:
753
+ - array
754
+ - 'null'
755
+ description: Abuse mailbox email addresses for the organization.
756
+ items:
757
+ type: string
758
+ phone:
759
+ type:
760
+ - array
761
+ - 'null'
762
+ description: Phone numbers for the organization.
763
+ items:
764
+ type: string
765
+ fax_no:
766
+ type:
767
+ - array
768
+ - 'null'
769
+ description: Fax numbers for the organization.
770
+ items:
771
+ type: string
772
+ admin_contacts:
773
+ type:
774
+ - array
775
+ - 'null'
776
+ description: Handles of admin persons or roles linked to this organization.
777
+ items:
778
+ type: string
779
+ tech_contacts:
780
+ type:
781
+ - array
782
+ - 'null'
783
+ description: Handles of technical persons or roles linked to this organization.
784
+ items:
785
+ type: string
786
+ abuse_contacts:
787
+ type:
788
+ - array
789
+ - 'null'
790
+ description: Handles of abuse persons or roles linked to this organization.
791
+ items:
792
+ type: string
793
+ remarks:
794
+ type:
795
+ - array
796
+ - 'null'
797
+ description: Remarks for this organization object.
798
+ items:
799
+ type: string
800
+ notify:
801
+ type:
802
+ - array
803
+ - 'null'
804
+ description: Notify email addresses for this organization object.
805
+ items:
806
+ type: string
807
+ ref_nfy:
808
+ type:
809
+ - array
810
+ - 'null'
811
+ description: Reference notification email addresses for this organization object.
812
+ items:
813
+ type: string
814
+ mnt_by:
815
+ type:
816
+ - array
817
+ - 'null'
818
+ description: Maintainer handles for this organization object.
819
+ items:
820
+ type: string
821
+ mnt_ref:
822
+ type:
823
+ - array
824
+ - 'null'
825
+ description: Referenced maintainer handles for this organization object.
826
+ items:
827
+ type: string
828
+ date_created:
829
+ type:
830
+ - string
831
+ - 'null'
832
+ format: date
833
+ description: Registration date of this organization object (YYYY-MM-DD).
834
+ date_updated:
835
+ type:
836
+ - string
837
+ - 'null'
838
+ format: date
839
+ description: Last update date of this organization object (YYYY-MM-DD).
840
+ source:
841
+ type: string
842
+ description: WHOIS data source (RIR registry URL) for this object.
843
+ WhoisContactRef:
844
+ type: object
845
+ description: Contact person or role object with handle, name, email, phone, and source reference.
846
+ required:
847
+ - handle
848
+ - source
849
+ properties:
850
+ handle:
851
+ type: string
852
+ description: Handle or unique identifier of this contact in WHOIS data.
853
+ name:
854
+ type:
855
+ - string
856
+ - 'null'
857
+ description: Name of the contact person or role.
858
+ address:
859
+ type:
860
+ - array
861
+ - 'null'
862
+ description: Address lines for this contact.
863
+ items:
864
+ type: string
865
+ street:
866
+ type:
867
+ - string
868
+ - 'null'
869
+ description: Parsed street address from the address field.
870
+ city:
871
+ type:
872
+ - string
873
+ - 'null'
874
+ description: Parsed city from the address field.
875
+ district:
876
+ type:
877
+ - string
878
+ - 'null'
879
+ description: Parsed district from the address field.
880
+ state:
881
+ type:
882
+ - string
883
+ - 'null'
884
+ description: Parsed state from the address field.
885
+ zip_code:
886
+ type:
887
+ - string
888
+ - 'null'
889
+ description: Parsed ZIP code from the address field.
890
+ country:
891
+ type:
892
+ - string
893
+ - 'null'
894
+ description: Parsed country from the address field.
895
+ email:
896
+ type:
897
+ - array
898
+ - 'null'
899
+ description: Email addresses for this contact.
900
+ items:
901
+ type: string
902
+ abuse_mailbox:
903
+ type:
904
+ - array
905
+ - 'null'
906
+ description: Abuse mailbox email addresses for this contact.
907
+ items:
908
+ type: string
909
+ phone:
910
+ type:
911
+ - array
912
+ - 'null'
913
+ description: Phone numbers for this contact.
914
+ items:
915
+ type: string
916
+ fax_no:
917
+ type:
918
+ - array
919
+ - 'null'
920
+ description: Fax numbers for this contact.
921
+ items:
922
+ type: string
923
+ organizations:
924
+ type:
925
+ - array
926
+ - 'null'
927
+ description: Handles of organization objects managing this contact.
928
+ items:
929
+ type: string
930
+ admin_contacts:
931
+ type:
932
+ - array
933
+ - 'null'
934
+ description: Handles of admin persons or roles linked to this contact.
935
+ items:
936
+ type: string
937
+ tech_contacts:
938
+ type:
939
+ - array
940
+ - 'null'
941
+ description: Handles of technical persons or roles linked to this contact.
942
+ items:
943
+ type: string
944
+ remarks:
945
+ type:
946
+ - array
947
+ - 'null'
948
+ description: Remarks for this contact object.
949
+ items:
950
+ type: string
951
+ notify:
952
+ type:
953
+ - array
954
+ - 'null'
955
+ description: Notify email addresses for this contact object.
956
+ items:
957
+ type: string
958
+ mnt_by:
959
+ type:
960
+ - array
961
+ - 'null'
962
+ description: Maintainer handles for this contact object.
963
+ items:
964
+ type: string
965
+ mnt_ref:
966
+ type:
967
+ - array
968
+ - 'null'
969
+ description: Referenced maintainer handles for this contact object.
970
+ items:
971
+ type: string
972
+ date_created:
973
+ type:
974
+ - string
975
+ - 'null'
976
+ format: date
977
+ description: Registration date of this contact object (YYYY-MM-DD).
978
+ date_updated:
979
+ type:
980
+ - string
981
+ - 'null'
982
+ format: date
983
+ description: Last update date of this contact object (YYYY-MM-DD).
984
+ source:
985
+ type: string
986
+ description: WHOIS data source (RIR registry URL) for this object.
987
+ RouteObject:
988
+ type: object
989
+ description: BGP route object containing the route prefix, origin AS, and related metadata.
990
+ required: []
991
+ properties:
992
+ route:
993
+ type:
994
+ - string
995
+ - 'null'
996
+ description: BGP route prefix (e.g., 8.8.8.0/24).
997
+ origin:
998
+ type:
999
+ - string
1000
+ - 'null'
1001
+ description: Origin AS number for this route.
1002
+ description:
1003
+ type:
1004
+ - array
1005
+ - 'null'
1006
+ description: Description values for this route object.
1007
+ items:
1008
+ type: string
1009
+ country:
1010
+ type:
1011
+ - string
1012
+ - 'null'
1013
+ description: Country of the organization managing this route.
1014
+ pingable:
1015
+ type:
1016
+ - array
1017
+ - 'null'
1018
+ description: Pingable IP addresses in this route.
1019
+ items:
1020
+ type: string
1021
+ ping_hdl:
1022
+ type:
1023
+ - array
1024
+ - 'null'
1025
+ description: Handles of pingable contacts for this route.
1026
+ items:
1027
+ type: string
1028
+ holes:
1029
+ type:
1030
+ - array
1031
+ - 'null'
1032
+ description: Sub-allocation holes (more specific routes) within this route.
1033
+ items:
1034
+ type: string
1035
+ member_of:
1036
+ type:
1037
+ - array
1038
+ - 'null'
1039
+ description: Route sets this route is a member of.
1040
+ items:
1041
+ type: string
1042
+ inject:
1043
+ type:
1044
+ - array
1045
+ - 'null'
1046
+ description: Injection details for this route.
1047
+ items:
1048
+ type: string
1049
+ aggr_mtd:
1050
+ type:
1051
+ - string
1052
+ - 'null'
1053
+ description: Aggregation method for this route.
1054
+ aggr_bndry:
1055
+ type:
1056
+ - string
1057
+ - 'null'
1058
+ description: Aggregation boundary for this route.
1059
+ export_comps:
1060
+ type:
1061
+ - string
1062
+ - 'null'
1063
+ description: Export composition for this route.
1064
+ components:
1065
+ type:
1066
+ - string
1067
+ - 'null'
1068
+ description: Route components.
1069
+ organizations:
1070
+ type:
1071
+ - array
1072
+ - 'null'
1073
+ description: Handles of organization objects related to this route.
1074
+ items:
1075
+ type: string
1076
+ remarks:
1077
+ type:
1078
+ - array
1079
+ - 'null'
1080
+ description: Remarks for this route object.
1081
+ items:
1082
+ type: string
1083
+ notify:
1084
+ type:
1085
+ - array
1086
+ - 'null'
1087
+ description: Notify email addresses for this route object.
1088
+ items:
1089
+ type: string
1090
+ mnt_lower:
1091
+ type:
1092
+ - array
1093
+ - 'null'
1094
+ description: Lower-level maintainer handles for this route.
1095
+ items:
1096
+ type: string
1097
+ mnt_by:
1098
+ type:
1099
+ - array
1100
+ - 'null'
1101
+ description: Maintainer handles for this route object.
1102
+ items:
1103
+ type: string
1104
+ date_created:
1105
+ type:
1106
+ - string
1107
+ - 'null'
1108
+ format: date
1109
+ description: Registration date of this route object (YYYY-MM-DD).
1110
+ date_updated:
1111
+ type:
1112
+ - string
1113
+ - 'null'
1114
+ format: date
1115
+ description: Last update date of this route object (YYYY-MM-DD).
1116
+ source:
1117
+ type:
1118
+ - string
1119
+ - 'null'
1120
+ description: WHOIS data source for this route object.
1121
+ security:
1122
+ - ApiKeyAuthHeader: []
1123
+ - ApiKeyAuthQuery: []