apifreaks 1.0.2 → 1.0.4
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.
- checksums.yaml +4 -4
- data/lib/apifreaks/client.rb +329 -10
- data/lib/apifreaks/types/astronomy_lookup_response.rb +1 -1
- data/lib/apifreaks/types/astronomy_lookup_response_location.rb +7 -7
- data/lib/apifreaks/types/bulk_domain_availability_check_response.rb +1 -1
- data/lib/apifreaks/types/bulk_domain_availability_check_response_bulk_domain_available_response_item.rb +3 -3
- data/lib/apifreaks/types/bulk_domain_dns_lookup_request.rb +3 -1
- data/lib/apifreaks/types/bulk_domain_dns_lookup_response_bulk_dns_info_item.rb +4 -2
- data/lib/apifreaks/types/bulk_domain_dns_lookup_response_bulk_dns_info_item_dns_types.rb +2 -0
- data/lib/apifreaks/types/bulk_email_validate_response_email_validation_responses_item.rb +1 -1
- data/lib/apifreaks/types/bulk_email_validate_response_email_validation_responses_item_dns.rb +1 -1
- data/lib/apifreaks/types/bulk_email_validate_response_email_validation_responses_item_valid_email.rb +3 -1
- data/lib/apifreaks/types/bulk_geolocation_lookup_response_item.rb +1 -1
- data/lib/apifreaks/types/bulk_zipcode_lookup_response_results_item.rb +0 -2
- data/lib/apifreaks/types/commodity_fluctuation_request.rb +1 -1
- data/lib/apifreaks/types/commodity_fluctuation_response.rb +3 -7
- data/lib/apifreaks/types/commodity_historical_rates_request.rb +1 -1
- data/lib/apifreaks/types/commodity_historical_rates_response.rb +3 -5
- data/lib/apifreaks/types/commodity_latest_rates_request.rb +1 -1
- data/lib/apifreaks/types/commodity_latest_rates_response.rb +2 -2
- data/lib/apifreaks/types/commodity_time_series_request.rb +1 -1
- data/lib/apifreaks/types/commodity_time_series_response.rb +3 -7
- data/lib/apifreaks/types/currency_convert_by_ip_request.rb +1 -1
- data/lib/apifreaks/types/currency_convert_historical_request.rb +1 -1
- data/lib/apifreaks/types/currency_convert_latest_request.rb +1 -1
- data/lib/apifreaks/types/domain_availability_check_response.rb +2 -4
- data/lib/apifreaks/types/domain_availability_suggestions_request.rb +2 -0
- data/lib/apifreaks/types/domain_availability_suggestions_response.rb +1 -1
- data/lib/apifreaks/types/domain_availability_suggestions_response_domain_available_response_item.rb +2 -4
- data/lib/apifreaks/types/domain_dns_history_request.rb +1 -1
- data/lib/apifreaks/types/domain_dns_history_response.rb +4 -4
- data/lib/apifreaks/types/domain_dns_history_response_historical_dns_records_item.rb +0 -2
- data/lib/apifreaks/types/domain_dns_lookup_request.rb +1 -1
- data/lib/apifreaks/types/domain_dns_reverse_response_reverse_dns_records_item.rb +1 -1
- data/lib/apifreaks/types/domain_ssl_chain_lookup_response_ssl_certificates_item_extensions_authority_info_access.rb +2 -2
- data/lib/apifreaks/types/domain_ssl_chain_lookup_response_ssl_certificates_item_issuer.rb +2 -2
- data/lib/apifreaks/types/domain_ssl_lookup_response_ssl_certificates_item_extensions_authority_info_access.rb +2 -2
- data/lib/apifreaks/types/domain_ssl_lookup_response_ssl_certificates_item_issuer.rb +2 -2
- data/lib/apifreaks/types/domain_whois_history_response_whois_domains_historical_item_administrative_contact.rb +2 -2
- data/lib/apifreaks/types/domain_whois_history_response_whois_domains_historical_item_billing_contact.rb +2 -2
- data/lib/apifreaks/types/domain_whois_history_response_whois_domains_historical_item_registrant_contact.rb +2 -2
- data/lib/apifreaks/types/domain_whois_history_response_whois_domains_historical_item_technical_contact.rb +2 -2
- data/lib/apifreaks/types/domain_whois_reverse_response.rb +3 -3
- data/lib/apifreaks/types/domain_whois_reverse_response_whois_domains_historical_item_companyname.rb +1 -1
- data/lib/apifreaks/types/email_validate_response.rb +1 -1
- data/lib/apifreaks/types/email_validate_response_dns.rb +1 -1
- data/lib/apifreaks/types/email_validate_response_valid_email.rb +3 -1
- data/lib/apifreaks/types/geolocation_lookup_response.rb +1 -1
- data/lib/apifreaks/types/get_admin_unit_details_response.rb +3 -1
- data/lib/apifreaks/types/subdomains_lookup_response_subdomains_item.rb +1 -1
- data/lib/apifreaks/types/timezone_lookup_response.rb +2 -2
- data/lib/apifreaks/types/timezone_lookup_response_airport_details.rb +12 -12
- data/lib/apifreaks/types/timezone_lookup_response_lo_code_details.rb +8 -8
- data/lib/apifreaks/types/timezone_lookup_response_time_zone.rb +2 -10
- data/lib/apifreaks/types/user_agent_lookup_request.rb +2 -0
- data/lib/apifreaks/types/vat_validate_response.rb +2 -2
- data/lib/apifreaks/types/zipcode_distance_match_response.rb +1 -1
- data/lib/apifreaks/types/zipcode_distance_response.rb +1 -1
- data/lib/apifreaks/types/zipcode_lookup_response_results_item.rb +0 -2
- data/lib/apifreaks/types/zipcode_search_by_radius_response_results_item.rb +0 -2
- data/lib/apifreaks/version.rb +1 -1
- data/lib/apifreaks.rb +0 -3
- data/reference.md +825 -129
- metadata +3 -9
- data/lib/apifreaks/types/commodity_fluctuation_response_rates_value.rb +0 -15
- data/lib/apifreaks/types/commodity_historical_rates_response_rates_value.rb +0 -17
- data/lib/apifreaks/types/commodity_time_series_response_rates_value_value.rb +0 -15
data/reference.md
CHANGED
|
@@ -105,6 +105,116 @@ client.geolocation_lookup(api_key: "apiKey")
|
|
|
105
105
|
</dl>
|
|
106
106
|
|
|
107
107
|
|
|
108
|
+
</dd>
|
|
109
|
+
</dl>
|
|
110
|
+
</details>
|
|
111
|
+
|
|
112
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">geolocation_lookup_v2</a>() -> Apifreaks::Types::GeolocationLookupResponse</code></summary>
|
|
113
|
+
<dl>
|
|
114
|
+
<dd>
|
|
115
|
+
|
|
116
|
+
#### 📝 Description
|
|
117
|
+
|
|
118
|
+
<dl>
|
|
119
|
+
<dd>
|
|
120
|
+
|
|
121
|
+
<dl>
|
|
122
|
+
<dd>
|
|
123
|
+
|
|
124
|
+
Get detailed geolocation data for an IP address using the `v2.0/geolocation/lookup` endpoint including country, city, timezone, currency, and optional security and user-agent information
|
|
125
|
+
</dd>
|
|
126
|
+
</dl>
|
|
127
|
+
</dd>
|
|
128
|
+
</dl>
|
|
129
|
+
|
|
130
|
+
#### 🔌 Usage
|
|
131
|
+
|
|
132
|
+
<dl>
|
|
133
|
+
<dd>
|
|
134
|
+
|
|
135
|
+
<dl>
|
|
136
|
+
<dd>
|
|
137
|
+
|
|
138
|
+
```ruby
|
|
139
|
+
client.geolocation_lookup_v2(api_key: "apiKey")
|
|
140
|
+
```
|
|
141
|
+
</dd>
|
|
142
|
+
</dl>
|
|
143
|
+
</dd>
|
|
144
|
+
</dl>
|
|
145
|
+
|
|
146
|
+
#### ⚙️ Parameters
|
|
147
|
+
|
|
148
|
+
<dl>
|
|
149
|
+
<dd>
|
|
150
|
+
|
|
151
|
+
<dl>
|
|
152
|
+
<dd>
|
|
153
|
+
|
|
154
|
+
**api_key:** `String` — Your API key
|
|
155
|
+
|
|
156
|
+
</dd>
|
|
157
|
+
</dl>
|
|
158
|
+
|
|
159
|
+
<dl>
|
|
160
|
+
<dd>
|
|
161
|
+
|
|
162
|
+
**format:** `Apifreaks::Types::GeolocationLookupRequestFormat` — Format of the response.
|
|
163
|
+
|
|
164
|
+
</dd>
|
|
165
|
+
</dl>
|
|
166
|
+
|
|
167
|
+
<dl>
|
|
168
|
+
<dd>
|
|
169
|
+
|
|
170
|
+
**ip:** `String` — IPv4, IPv6, or hostname for geolocation lookup
|
|
171
|
+
|
|
172
|
+
</dd>
|
|
173
|
+
</dl>
|
|
174
|
+
|
|
175
|
+
<dl>
|
|
176
|
+
<dd>
|
|
177
|
+
|
|
178
|
+
**lang:** `Apifreaks::Types::GeolocationLookupRequestLang` — Response language for location fields
|
|
179
|
+
|
|
180
|
+
</dd>
|
|
181
|
+
</dl>
|
|
182
|
+
|
|
183
|
+
<dl>
|
|
184
|
+
<dd>
|
|
185
|
+
|
|
186
|
+
**fields:** `String` — Comma separated list of fields to include in response
|
|
187
|
+
|
|
188
|
+
</dd>
|
|
189
|
+
</dl>
|
|
190
|
+
|
|
191
|
+
<dl>
|
|
192
|
+
<dd>
|
|
193
|
+
|
|
194
|
+
**excludes:** `String` — Comma separated list of fields to exclude from response
|
|
195
|
+
|
|
196
|
+
</dd>
|
|
197
|
+
</dl>
|
|
198
|
+
|
|
199
|
+
<dl>
|
|
200
|
+
<dd>
|
|
201
|
+
|
|
202
|
+
**include:** `String` — Additional data to include (location, network, security, currency, time_zone, user_agent, country_metadata , hostname, liveHostname, hostnameFallbackLivet)
|
|
203
|
+
|
|
204
|
+
</dd>
|
|
205
|
+
</dl>
|
|
206
|
+
|
|
207
|
+
<dl>
|
|
208
|
+
<dd>
|
|
209
|
+
|
|
210
|
+
**request_options:** `Apifreaks::RequestOptions`
|
|
211
|
+
|
|
212
|
+
</dd>
|
|
213
|
+
</dl>
|
|
214
|
+
</dd>
|
|
215
|
+
</dl>
|
|
216
|
+
|
|
217
|
+
|
|
108
218
|
</dd>
|
|
109
219
|
</dl>
|
|
110
220
|
</details>
|
|
@@ -219,6 +329,120 @@ client.bulk_geolocation_lookup(
|
|
|
219
329
|
</dl>
|
|
220
330
|
|
|
221
331
|
|
|
332
|
+
</dd>
|
|
333
|
+
</dl>
|
|
334
|
+
</details>
|
|
335
|
+
|
|
336
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">bulk_geolocation_lookup_v2</a>(request) -> Internal::Types::Array[Apifreaks::Types::BulkGeolocationLookupResponseItem]</code></summary>
|
|
337
|
+
<dl>
|
|
338
|
+
<dd>
|
|
339
|
+
|
|
340
|
+
#### 📝 Description
|
|
341
|
+
|
|
342
|
+
<dl>
|
|
343
|
+
<dd>
|
|
344
|
+
|
|
345
|
+
<dl>
|
|
346
|
+
<dd>
|
|
347
|
+
|
|
348
|
+
Retrieve detailed geolocation data for multiple IP addresses in a single request using the `v2.0/geolocation/lookup` endpoint.
|
|
349
|
+
Supports up to `50,000` IP-addresses/host-names per request.
|
|
350
|
+
</dd>
|
|
351
|
+
</dl>
|
|
352
|
+
</dd>
|
|
353
|
+
</dl>
|
|
354
|
+
|
|
355
|
+
#### 🔌 Usage
|
|
356
|
+
|
|
357
|
+
<dl>
|
|
358
|
+
<dd>
|
|
359
|
+
|
|
360
|
+
<dl>
|
|
361
|
+
<dd>
|
|
362
|
+
|
|
363
|
+
```ruby
|
|
364
|
+
client.bulk_geolocation_lookup_v2(
|
|
365
|
+
api_key: "apiKey",
|
|
366
|
+
ips: ["ips"]
|
|
367
|
+
)
|
|
368
|
+
```
|
|
369
|
+
</dd>
|
|
370
|
+
</dl>
|
|
371
|
+
</dd>
|
|
372
|
+
</dl>
|
|
373
|
+
|
|
374
|
+
#### ⚙️ Parameters
|
|
375
|
+
|
|
376
|
+
<dl>
|
|
377
|
+
<dd>
|
|
378
|
+
|
|
379
|
+
<dl>
|
|
380
|
+
<dd>
|
|
381
|
+
|
|
382
|
+
**api_key:** `String` — Your API key
|
|
383
|
+
|
|
384
|
+
</dd>
|
|
385
|
+
</dl>
|
|
386
|
+
|
|
387
|
+
<dl>
|
|
388
|
+
<dd>
|
|
389
|
+
|
|
390
|
+
**format:** `Apifreaks::Types::BulkGeolocationLookupRequestFormat` — Format of the response.
|
|
391
|
+
|
|
392
|
+
</dd>
|
|
393
|
+
</dl>
|
|
394
|
+
|
|
395
|
+
<dl>
|
|
396
|
+
<dd>
|
|
397
|
+
|
|
398
|
+
**lang:** `String` — Language of the response.
|
|
399
|
+
|
|
400
|
+
</dd>
|
|
401
|
+
</dl>
|
|
402
|
+
|
|
403
|
+
<dl>
|
|
404
|
+
<dd>
|
|
405
|
+
|
|
406
|
+
**fields:** `String` — Comma-separated list of fields to include in the response. Can include "geo".
|
|
407
|
+
|
|
408
|
+
</dd>
|
|
409
|
+
</dl>
|
|
410
|
+
|
|
411
|
+
<dl>
|
|
412
|
+
<dd>
|
|
413
|
+
|
|
414
|
+
**excludes:** `String` — Comma-separated list of fields to exclude from the response (except "ip").
|
|
415
|
+
|
|
416
|
+
</dd>
|
|
417
|
+
</dl>
|
|
418
|
+
|
|
419
|
+
<dl>
|
|
420
|
+
<dd>
|
|
421
|
+
|
|
422
|
+
**include:** `String` — Comma-separated list of additional information to include in the response.
|
|
423
|
+
|
|
424
|
+
</dd>
|
|
425
|
+
</dl>
|
|
426
|
+
|
|
427
|
+
<dl>
|
|
428
|
+
<dd>
|
|
429
|
+
|
|
430
|
+
**ips:** `Internal::Types::Array[String]` — List of IP addresses or hostnames to lookup
|
|
431
|
+
|
|
432
|
+
</dd>
|
|
433
|
+
</dl>
|
|
434
|
+
|
|
435
|
+
<dl>
|
|
436
|
+
<dd>
|
|
437
|
+
|
|
438
|
+
**request_options:** `Apifreaks::RequestOptions`
|
|
439
|
+
|
|
440
|
+
</dd>
|
|
441
|
+
</dl>
|
|
442
|
+
</dd>
|
|
443
|
+
</dl>
|
|
444
|
+
|
|
445
|
+
|
|
222
446
|
</dd>
|
|
223
447
|
</dl>
|
|
224
448
|
</details>
|
|
@@ -483,31 +707,212 @@ client.geocoder_search(
|
|
|
483
707
|
<dl>
|
|
484
708
|
<dd>
|
|
485
709
|
|
|
486
|
-
**limit:** `Integer` — Max number of results to return (1–40). May return fewer if matches are weak.
|
|
487
|
-
|
|
488
|
-
</dd>
|
|
489
|
-
</dl>
|
|
490
|
-
|
|
710
|
+
**limit:** `Integer` — Max number of results to return (1–40). May return fewer if matches are weak.
|
|
711
|
+
|
|
712
|
+
</dd>
|
|
713
|
+
</dl>
|
|
714
|
+
|
|
715
|
+
<dl>
|
|
716
|
+
<dd>
|
|
717
|
+
|
|
718
|
+
**min_lat:** `Integer` — Minimum latitude for the viewbox. Must be ≤ max_lat and between -90 and 90.
|
|
719
|
+
|
|
720
|
+
</dd>
|
|
721
|
+
</dl>
|
|
722
|
+
|
|
723
|
+
<dl>
|
|
724
|
+
<dd>
|
|
725
|
+
|
|
726
|
+
**max_lat:** `Integer` — Maximum latitude for the viewbox. Must be ≥ min_lat and between -90 and 90.
|
|
727
|
+
|
|
728
|
+
</dd>
|
|
729
|
+
</dl>
|
|
730
|
+
|
|
731
|
+
<dl>
|
|
732
|
+
<dd>
|
|
733
|
+
|
|
734
|
+
**min_lon:** `Integer` — Minimum longitude for the viewbox. Must be ≤ max_lon and between -180 and 180.
|
|
735
|
+
|
|
736
|
+
</dd>
|
|
737
|
+
</dl>
|
|
738
|
+
|
|
739
|
+
<dl>
|
|
740
|
+
<dd>
|
|
741
|
+
|
|
742
|
+
**max_lon:** `Integer` — Maximum longitude for the viewbox. Must be ≥ min_lon and between -180 and 180.
|
|
743
|
+
|
|
744
|
+
</dd>
|
|
745
|
+
</dl>
|
|
746
|
+
|
|
747
|
+
<dl>
|
|
748
|
+
<dd>
|
|
749
|
+
|
|
750
|
+
**accept_language:** `String` — Preferred language order for showing search results. This may either be a simple comma-separated list of language codes or a single entry. The results will be in the 1st language which is matched from the header. As a fallback if the results are not supported in the given language, 'en' will be used.
|
|
751
|
+
|
|
752
|
+
</dd>
|
|
753
|
+
</dl>
|
|
754
|
+
|
|
755
|
+
<dl>
|
|
756
|
+
<dd>
|
|
757
|
+
|
|
758
|
+
**request_options:** `Apifreaks::RequestOptions`
|
|
759
|
+
|
|
760
|
+
</dd>
|
|
761
|
+
</dl>
|
|
762
|
+
</dd>
|
|
763
|
+
</dl>
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
</dd>
|
|
767
|
+
</dl>
|
|
768
|
+
</details>
|
|
769
|
+
|
|
770
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">geocoder_reverse</a>() -> Apifreaks::Types::GeocoderReverseResponse</code></summary>
|
|
771
|
+
<dl>
|
|
772
|
+
<dd>
|
|
773
|
+
|
|
774
|
+
#### 📝 Description
|
|
775
|
+
|
|
776
|
+
<dl>
|
|
777
|
+
<dd>
|
|
778
|
+
|
|
779
|
+
<dl>
|
|
780
|
+
<dd>
|
|
781
|
+
|
|
782
|
+
Convert geographic coordinates (latitude and longitude) into a human-readable address or place name.
|
|
783
|
+
</dd>
|
|
784
|
+
</dl>
|
|
785
|
+
</dd>
|
|
786
|
+
</dl>
|
|
787
|
+
|
|
788
|
+
#### 🔌 Usage
|
|
789
|
+
|
|
790
|
+
<dl>
|
|
791
|
+
<dd>
|
|
792
|
+
|
|
793
|
+
<dl>
|
|
794
|
+
<dd>
|
|
795
|
+
|
|
796
|
+
```ruby
|
|
797
|
+
client.geocoder_reverse(
|
|
798
|
+
api_key: "apiKey",
|
|
799
|
+
lat: 1.1,
|
|
800
|
+
lon: 1.1
|
|
801
|
+
)
|
|
802
|
+
```
|
|
803
|
+
</dd>
|
|
804
|
+
</dl>
|
|
805
|
+
</dd>
|
|
806
|
+
</dl>
|
|
807
|
+
|
|
808
|
+
#### ⚙️ Parameters
|
|
809
|
+
|
|
810
|
+
<dl>
|
|
811
|
+
<dd>
|
|
812
|
+
|
|
813
|
+
<dl>
|
|
814
|
+
<dd>
|
|
815
|
+
|
|
816
|
+
**api_key:** `String` — Your API key
|
|
817
|
+
|
|
818
|
+
</dd>
|
|
819
|
+
</dl>
|
|
820
|
+
|
|
821
|
+
<dl>
|
|
822
|
+
<dd>
|
|
823
|
+
|
|
824
|
+
**format:** `Apifreaks::Types::GeocoderReverseRequestFormat` — Format of the response.
|
|
825
|
+
|
|
826
|
+
</dd>
|
|
827
|
+
</dl>
|
|
828
|
+
|
|
829
|
+
<dl>
|
|
830
|
+
<dd>
|
|
831
|
+
|
|
832
|
+
**lat:** `Integer` — WGS84 latitude value ranging from -90 to 90.
|
|
833
|
+
|
|
834
|
+
</dd>
|
|
835
|
+
</dl>
|
|
836
|
+
|
|
837
|
+
<dl>
|
|
838
|
+
<dd>
|
|
839
|
+
|
|
840
|
+
**lon:** `Integer` — WGS84 longitude value ranging from -180 to 180.
|
|
841
|
+
|
|
842
|
+
</dd>
|
|
843
|
+
</dl>
|
|
844
|
+
|
|
845
|
+
<dl>
|
|
846
|
+
<dd>
|
|
847
|
+
|
|
848
|
+
**accept_language:** `String` — Preferred language order for showing search results. This may either be a simple comma-separated list of language codes or a single entry. The results will be in the 1st language which is matched from the header. As a fallback if the results are not supported in the given language, en will be used.
|
|
849
|
+
|
|
850
|
+
</dd>
|
|
851
|
+
</dl>
|
|
852
|
+
|
|
853
|
+
<dl>
|
|
854
|
+
<dd>
|
|
855
|
+
|
|
856
|
+
**request_options:** `Apifreaks::RequestOptions`
|
|
857
|
+
|
|
858
|
+
</dd>
|
|
859
|
+
</dl>
|
|
860
|
+
</dd>
|
|
861
|
+
</dl>
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
</dd>
|
|
865
|
+
</dl>
|
|
866
|
+
</details>
|
|
867
|
+
|
|
868
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">domain_whois_lookup</a>() -> Apifreaks::Types::DomainWhoisLookupResponse</code></summary>
|
|
869
|
+
<dl>
|
|
870
|
+
<dd>
|
|
871
|
+
|
|
872
|
+
#### 📝 Description
|
|
873
|
+
|
|
874
|
+
<dl>
|
|
875
|
+
<dd>
|
|
876
|
+
|
|
877
|
+
<dl>
|
|
878
|
+
<dd>
|
|
879
|
+
|
|
880
|
+
Retrieve current WHOIS information for a domain name.
|
|
881
|
+
This endpoint provides detailed registration information including registrar details,
|
|
882
|
+
dates, nameservers, and registrant information.
|
|
883
|
+
</dd>
|
|
884
|
+
</dl>
|
|
885
|
+
</dd>
|
|
886
|
+
</dl>
|
|
887
|
+
|
|
888
|
+
#### 🔌 Usage
|
|
889
|
+
|
|
890
|
+
<dl>
|
|
891
|
+
<dd>
|
|
892
|
+
|
|
491
893
|
<dl>
|
|
492
894
|
<dd>
|
|
493
895
|
|
|
494
|
-
|
|
495
|
-
|
|
896
|
+
```ruby
|
|
897
|
+
client.domain_whois_lookup(
|
|
898
|
+
api_key: "apiKey",
|
|
899
|
+
domain_name: "domainName"
|
|
900
|
+
)
|
|
901
|
+
```
|
|
496
902
|
</dd>
|
|
497
903
|
</dl>
|
|
904
|
+
</dd>
|
|
905
|
+
</dl>
|
|
906
|
+
|
|
907
|
+
#### ⚙️ Parameters
|
|
498
908
|
|
|
499
909
|
<dl>
|
|
500
910
|
<dd>
|
|
501
911
|
|
|
502
|
-
**max_lat:** `Integer` — Maximum latitude for the viewbox. Must be ≥ min_lat and between -90 and 90.
|
|
503
|
-
|
|
504
|
-
</dd>
|
|
505
|
-
</dl>
|
|
506
|
-
|
|
507
912
|
<dl>
|
|
508
913
|
<dd>
|
|
509
914
|
|
|
510
|
-
**
|
|
915
|
+
**api_key:** `String` — Your API key
|
|
511
916
|
|
|
512
917
|
</dd>
|
|
513
918
|
</dl>
|
|
@@ -515,7 +920,7 @@ client.geocoder_search(
|
|
|
515
920
|
<dl>
|
|
516
921
|
<dd>
|
|
517
922
|
|
|
518
|
-
**
|
|
923
|
+
**format:** `Apifreaks::Types::DomainWhoisLookupRequestFormat` — Response format (defaults to json)
|
|
519
924
|
|
|
520
925
|
</dd>
|
|
521
926
|
</dl>
|
|
@@ -523,7 +928,7 @@ client.geocoder_search(
|
|
|
523
928
|
<dl>
|
|
524
929
|
<dd>
|
|
525
930
|
|
|
526
|
-
**
|
|
931
|
+
**domain_name:** `String` — Domain name for WHOIS lookup
|
|
527
932
|
|
|
528
933
|
</dd>
|
|
529
934
|
</dl>
|
|
@@ -543,7 +948,7 @@ client.geocoder_search(
|
|
|
543
948
|
</dl>
|
|
544
949
|
</details>
|
|
545
950
|
|
|
546
|
-
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">
|
|
951
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">domain_whois_lookup_v2</a>() -> Apifreaks::Types::DomainWhoisLookupResponse</code></summary>
|
|
547
952
|
<dl>
|
|
548
953
|
<dd>
|
|
549
954
|
|
|
@@ -555,7 +960,9 @@ client.geocoder_search(
|
|
|
555
960
|
<dl>
|
|
556
961
|
<dd>
|
|
557
962
|
|
|
558
|
-
|
|
963
|
+
Retrieve current WHOIS information for a domain name using the `v2.0/domain/whois/live` endpoint.
|
|
964
|
+
This endpoint provides detailed registration information including registrar details,
|
|
965
|
+
dates, nameservers, and registrant information.
|
|
559
966
|
</dd>
|
|
560
967
|
</dl>
|
|
561
968
|
</dd>
|
|
@@ -570,10 +977,9 @@ Convert geographic coordinates (latitude and longitude) into a human-readable ad
|
|
|
570
977
|
<dd>
|
|
571
978
|
|
|
572
979
|
```ruby
|
|
573
|
-
client.
|
|
980
|
+
client.domain_whois_lookup_v2(
|
|
574
981
|
api_key: "apiKey",
|
|
575
|
-
|
|
576
|
-
lon: 1.1
|
|
982
|
+
domain_name: "domainName"
|
|
577
983
|
)
|
|
578
984
|
```
|
|
579
985
|
</dd>
|
|
@@ -597,23 +1003,7 @@ client.geocoder_reverse(
|
|
|
597
1003
|
<dl>
|
|
598
1004
|
<dd>
|
|
599
1005
|
|
|
600
|
-
**format:** `Apifreaks::Types::
|
|
601
|
-
|
|
602
|
-
</dd>
|
|
603
|
-
</dl>
|
|
604
|
-
|
|
605
|
-
<dl>
|
|
606
|
-
<dd>
|
|
607
|
-
|
|
608
|
-
**lat:** `Integer` — WGS84 latitude value ranging from -90 to 90.
|
|
609
|
-
|
|
610
|
-
</dd>
|
|
611
|
-
</dl>
|
|
612
|
-
|
|
613
|
-
<dl>
|
|
614
|
-
<dd>
|
|
615
|
-
|
|
616
|
-
**lon:** `Integer` — WGS84 longitude value ranging from -180 to 180.
|
|
1006
|
+
**format:** `Apifreaks::Types::DomainWhoisLookupRequestFormat` — Response format (defaults to json)
|
|
617
1007
|
|
|
618
1008
|
</dd>
|
|
619
1009
|
</dl>
|
|
@@ -621,7 +1011,7 @@ client.geocoder_reverse(
|
|
|
621
1011
|
<dl>
|
|
622
1012
|
<dd>
|
|
623
1013
|
|
|
624
|
-
**
|
|
1014
|
+
**domain_name:** `String` — Domain name for WHOIS lookup
|
|
625
1015
|
|
|
626
1016
|
</dd>
|
|
627
1017
|
</dl>
|
|
@@ -641,7 +1031,7 @@ client.geocoder_reverse(
|
|
|
641
1031
|
</dl>
|
|
642
1032
|
</details>
|
|
643
1033
|
|
|
644
|
-
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">
|
|
1034
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">bulk_domain_whois_lookup</a>(request) -> Apifreaks::Types::BulkDomainWhoisLookupResponse</code></summary>
|
|
645
1035
|
<dl>
|
|
646
1036
|
<dd>
|
|
647
1037
|
|
|
@@ -653,9 +1043,7 @@ client.geocoder_reverse(
|
|
|
653
1043
|
<dl>
|
|
654
1044
|
<dd>
|
|
655
1045
|
|
|
656
|
-
Retrieve
|
|
657
|
-
This endpoint provides detailed registration information including registrar details,
|
|
658
|
-
dates, nameservers, and registrant information.
|
|
1046
|
+
Retrieve WHOIS information for `100 Domains per Request`.
|
|
659
1047
|
</dd>
|
|
660
1048
|
</dl>
|
|
661
1049
|
</dd>
|
|
@@ -670,9 +1058,9 @@ dates, nameservers, and registrant information.
|
|
|
670
1058
|
<dd>
|
|
671
1059
|
|
|
672
1060
|
```ruby
|
|
673
|
-
client.
|
|
1061
|
+
client.bulk_domain_whois_lookup(
|
|
674
1062
|
api_key: "apiKey",
|
|
675
|
-
|
|
1063
|
+
domain_names: ["domainNames"]
|
|
676
1064
|
)
|
|
677
1065
|
```
|
|
678
1066
|
</dd>
|
|
@@ -696,7 +1084,7 @@ client.domain_whois_lookup(
|
|
|
696
1084
|
<dl>
|
|
697
1085
|
<dd>
|
|
698
1086
|
|
|
699
|
-
**format:** `Apifreaks::Types::
|
|
1087
|
+
**format:** `Apifreaks::Types::BulkDomainWhoisLookupRequestFormat` — Format of the response.
|
|
700
1088
|
|
|
701
1089
|
</dd>
|
|
702
1090
|
</dl>
|
|
@@ -704,7 +1092,7 @@ client.domain_whois_lookup(
|
|
|
704
1092
|
<dl>
|
|
705
1093
|
<dd>
|
|
706
1094
|
|
|
707
|
-
**
|
|
1095
|
+
**domain_names:** `Internal::Types::Array[String]` — A list of domain names for which WHOIS data is requested.
|
|
708
1096
|
|
|
709
1097
|
</dd>
|
|
710
1098
|
</dl>
|
|
@@ -724,7 +1112,7 @@ client.domain_whois_lookup(
|
|
|
724
1112
|
</dl>
|
|
725
1113
|
</details>
|
|
726
1114
|
|
|
727
|
-
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">
|
|
1115
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">bulk_domain_whois_lookup_v2</a>(request) -> Apifreaks::Types::BulkDomainWhoisLookupResponse</code></summary>
|
|
728
1116
|
<dl>
|
|
729
1117
|
<dd>
|
|
730
1118
|
|
|
@@ -736,7 +1124,7 @@ client.domain_whois_lookup(
|
|
|
736
1124
|
<dl>
|
|
737
1125
|
<dd>
|
|
738
1126
|
|
|
739
|
-
Retrieve WHOIS information for `100 Domains per Request
|
|
1127
|
+
Retrieve WHOIS information for `100 Domains per Request` using the `v2.0/domain/whois/live` endpoint.
|
|
740
1128
|
</dd>
|
|
741
1129
|
</dl>
|
|
742
1130
|
</dd>
|
|
@@ -751,7 +1139,7 @@ Retrieve WHOIS information for `100 Domains per Request`.
|
|
|
751
1139
|
<dd>
|
|
752
1140
|
|
|
753
1141
|
```ruby
|
|
754
|
-
client.
|
|
1142
|
+
client.bulk_domain_whois_lookup_v2(
|
|
755
1143
|
api_key: "apiKey",
|
|
756
1144
|
domain_names: ["domainNames"]
|
|
757
1145
|
)
|
|
@@ -1252,7 +1640,7 @@ client.domain_dns_lookup(
|
|
|
1252
1640
|
<dl>
|
|
1253
1641
|
<dd>
|
|
1254
1642
|
|
|
1255
|
-
**type:** `String` — A comma-separated list of DNS record types for lookup. Possible values: A, AAAA, MX, NS, SOA, SPF, TXT, CNAME, or all. When ipAddress is provided, type must be "all".
|
|
1643
|
+
**type:** `String` — A comma-separated list of DNS record types for lookup. Possible values: A, AAAA, MX, NS, SOA, SPF, TXT, CNAME, or all. When ipAddress is provided, type must be "all". **Required**
|
|
1256
1644
|
|
|
1257
1645
|
</dd>
|
|
1258
1646
|
</dl>
|
|
@@ -1335,7 +1723,7 @@ client.bulk_domain_dns_lookup(
|
|
|
1335
1723
|
<dl>
|
|
1336
1724
|
<dd>
|
|
1337
1725
|
|
|
1338
|
-
**type:** `String`
|
|
1726
|
+
**type:** `String` **Required**
|
|
1339
1727
|
|
|
1340
1728
|
A comma-separated list of DNS record types for lookup.
|
|
1341
1729
|
Possible values: A, AAAA, MX, NS, SOA, SPF, TXT, CNAME, or all
|
|
@@ -1354,6 +1742,14 @@ Possible values: A, AAAA, MX, NS, SOA, SPF, TXT, CNAME, or all
|
|
|
1354
1742
|
<dl>
|
|
1355
1743
|
<dd>
|
|
1356
1744
|
|
|
1745
|
+
**ip_addresses:** `Internal::Types::Array[String]` — Optional list of IP addresses to perform reverse DNS (PTR) lookups for.
|
|
1746
|
+
|
|
1747
|
+
</dd>
|
|
1748
|
+
</dl>
|
|
1749
|
+
|
|
1750
|
+
<dl>
|
|
1751
|
+
<dd>
|
|
1752
|
+
|
|
1357
1753
|
**request_options:** `Apifreaks::RequestOptions`
|
|
1358
1754
|
|
|
1359
1755
|
</dd>
|
|
@@ -1437,7 +1833,7 @@ client.domain_dns_history(
|
|
|
1437
1833
|
<dl>
|
|
1438
1834
|
<dd>
|
|
1439
1835
|
|
|
1440
|
-
**type:** `String`
|
|
1836
|
+
**type:** `String` **Required**
|
|
1441
1837
|
|
|
1442
1838
|
A comma-separated list of DNS record types for lookup.
|
|
1443
1839
|
Possible values: A, AAAA, MX, NS, SOA, SPF, TXT, CNAME, or all
|
|
@@ -1834,7 +2230,7 @@ client.email_validate(
|
|
|
1834
2230
|
<dl>
|
|
1835
2231
|
<dd>
|
|
1836
2232
|
|
|
1837
|
-
**email:** `String` — Email address to validate
|
|
2233
|
+
**email:** `String` — Email address to validate **Required**
|
|
1838
2234
|
|
|
1839
2235
|
</dd>
|
|
1840
2236
|
</dl>
|
|
@@ -1933,7 +2329,7 @@ client.bulk_email_validate(
|
|
|
1933
2329
|
<dl>
|
|
1934
2330
|
<dd>
|
|
1935
2331
|
|
|
1936
|
-
**email_data:** `Internal::Types::Array[Apifreaks::Types::BulkEmailValidateRequestEmailDataItem]` — Array of email objects for bulk validation
|
|
2332
|
+
**email_data:** `Internal::Types::Array[Apifreaks::Types::BulkEmailValidateRequestEmailDataItem]` — Array of email objects for bulk validation **Required**
|
|
1937
2333
|
|
|
1938
2334
|
</dd>
|
|
1939
2335
|
</dl>
|
|
@@ -2580,6 +2976,14 @@ client.domain_availability_suggestions(
|
|
|
2580
2976
|
<dl>
|
|
2581
2977
|
<dd>
|
|
2582
2978
|
|
|
2979
|
+
**sug:** `Boolean` — Whether to return spelling/keyword-based domain name suggestions.
|
|
2980
|
+
|
|
2981
|
+
</dd>
|
|
2982
|
+
</dl>
|
|
2983
|
+
|
|
2984
|
+
<dl>
|
|
2985
|
+
<dd>
|
|
2986
|
+
|
|
2583
2987
|
**request_options:** `Apifreaks::RequestOptions`
|
|
2584
2988
|
|
|
2585
2989
|
</dd>
|
|
@@ -5020,6 +5424,14 @@ client.pdf_upload_resources(api_key: "apiKey")
|
|
|
5020
5424
|
<dl>
|
|
5021
5425
|
<dd>
|
|
5022
5426
|
|
|
5427
|
+
**file:** `File` — The PDF file to upload. **Required**
|
|
5428
|
+
|
|
5429
|
+
</dd>
|
|
5430
|
+
</dl>
|
|
5431
|
+
|
|
5432
|
+
<dl>
|
|
5433
|
+
<dd>
|
|
5434
|
+
|
|
5023
5435
|
**request_options:** `Apifreaks::RequestOptions`
|
|
5024
5436
|
|
|
5025
5437
|
</dd>
|
|
@@ -6406,7 +6818,7 @@ client.currency_convert_latest(
|
|
|
6406
6818
|
<dl>
|
|
6407
6819
|
<dd>
|
|
6408
6820
|
|
|
6409
|
-
**amount:** `
|
|
6821
|
+
**amount:** `String` — Amount to convert
|
|
6410
6822
|
|
|
6411
6823
|
</dd>
|
|
6412
6824
|
</dl>
|
|
@@ -6513,7 +6925,7 @@ client.currency_convert_historical(
|
|
|
6513
6925
|
<dl>
|
|
6514
6926
|
<dd>
|
|
6515
6927
|
|
|
6516
|
-
**amount:** `
|
|
6928
|
+
**amount:** `String` — The Amount to be converted
|
|
6517
6929
|
|
|
6518
6930
|
</dd>
|
|
6519
6931
|
</dl>
|
|
@@ -6837,7 +7249,7 @@ client.currency_convert_by_ip(
|
|
|
6837
7249
|
<dl>
|
|
6838
7250
|
<dd>
|
|
6839
7251
|
|
|
6840
|
-
**amount:** `
|
|
7252
|
+
**amount:** `String` — Amount to convert
|
|
6841
7253
|
|
|
6842
7254
|
</dd>
|
|
6843
7255
|
</dl>
|
|
@@ -7235,7 +7647,7 @@ client.commodity_historical_rates(
|
|
|
7235
7647
|
<dl>
|
|
7236
7648
|
<dd>
|
|
7237
7649
|
|
|
7238
|
-
**symbols:** `String` — Comma-separated list of commodity symbols
|
|
7650
|
+
**symbols:** `String` — Comma-separated list of commodity symbols **Required**
|
|
7239
7651
|
|
|
7240
7652
|
</dd>
|
|
7241
7653
|
</dl>
|
|
@@ -7318,7 +7730,7 @@ client.commodity_fluctuation(
|
|
|
7318
7730
|
<dl>
|
|
7319
7731
|
<dd>
|
|
7320
7732
|
|
|
7321
|
-
**symbols:** `String` — Comma-separated list of commodity symbols
|
|
7733
|
+
**symbols:** `String` — Comma-separated list of commodity symbols **Required**
|
|
7322
7734
|
|
|
7323
7735
|
</dd>
|
|
7324
7736
|
</dl>
|
|
@@ -7417,7 +7829,7 @@ client.commodity_time_series(
|
|
|
7417
7829
|
<dl>
|
|
7418
7830
|
<dd>
|
|
7419
7831
|
|
|
7420
|
-
**symbols:** `String` — Comma-separated list of commodity symbols
|
|
7832
|
+
**symbols:** `String` — Comma-separated list of commodity symbols **Required**
|
|
7421
7833
|
|
|
7422
7834
|
</dd>
|
|
7423
7835
|
</dl>
|
|
@@ -10397,31 +10809,182 @@ client.get_admin_unit_details(
|
|
|
10397
10809
|
<dl>
|
|
10398
10810
|
<dd>
|
|
10399
10811
|
|
|
10400
|
-
**api_key:** `String` — Your API key
|
|
10401
|
-
|
|
10812
|
+
**api_key:** `String` — Your API key
|
|
10813
|
+
|
|
10814
|
+
</dd>
|
|
10815
|
+
</dl>
|
|
10816
|
+
|
|
10817
|
+
<dl>
|
|
10818
|
+
<dd>
|
|
10819
|
+
|
|
10820
|
+
**format:** `Apifreaks::Types::GetAdminUnitDetailsRequestFormat` — Format of the response.
|
|
10821
|
+
|
|
10822
|
+
</dd>
|
|
10823
|
+
</dl>
|
|
10824
|
+
|
|
10825
|
+
<dl>
|
|
10826
|
+
<dd>
|
|
10827
|
+
|
|
10828
|
+
**country:** `String` — Country code in ISO 3166-1 alpha-2 format.
|
|
10829
|
+
|
|
10830
|
+
</dd>
|
|
10831
|
+
</dl>
|
|
10832
|
+
|
|
10833
|
+
<dl>
|
|
10834
|
+
<dd>
|
|
10835
|
+
|
|
10836
|
+
**admin_unit:** `String` — Optional admin code to fetch details for a specific administrative unit.
|
|
10837
|
+
|
|
10838
|
+
</dd>
|
|
10839
|
+
</dl>
|
|
10840
|
+
|
|
10841
|
+
<dl>
|
|
10842
|
+
<dd>
|
|
10843
|
+
|
|
10844
|
+
**request_options:** `Apifreaks::RequestOptions`
|
|
10845
|
+
|
|
10846
|
+
</dd>
|
|
10847
|
+
</dl>
|
|
10848
|
+
</dd>
|
|
10849
|
+
</dl>
|
|
10850
|
+
|
|
10851
|
+
|
|
10852
|
+
</dd>
|
|
10853
|
+
</dl>
|
|
10854
|
+
</details>
|
|
10855
|
+
|
|
10856
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">get_cities</a>() -> Apifreaks::Types::GetCitiesResponse</code></summary>
|
|
10857
|
+
<dl>
|
|
10858
|
+
<dd>
|
|
10859
|
+
|
|
10860
|
+
#### 📝 Description
|
|
10861
|
+
|
|
10862
|
+
<dl>
|
|
10863
|
+
<dd>
|
|
10864
|
+
|
|
10865
|
+
<dl>
|
|
10866
|
+
<dd>
|
|
10867
|
+
|
|
10868
|
+
Retrieve a list of cities within a country, optionally filtered by an administrative unit code.
|
|
10869
|
+
</dd>
|
|
10870
|
+
</dl>
|
|
10871
|
+
</dd>
|
|
10872
|
+
</dl>
|
|
10873
|
+
|
|
10874
|
+
#### 🔌 Usage
|
|
10875
|
+
|
|
10876
|
+
<dl>
|
|
10877
|
+
<dd>
|
|
10878
|
+
|
|
10879
|
+
<dl>
|
|
10880
|
+
<dd>
|
|
10881
|
+
|
|
10882
|
+
```ruby
|
|
10883
|
+
client.get_cities(
|
|
10884
|
+
api_key: "apiKey",
|
|
10885
|
+
country: "country"
|
|
10886
|
+
)
|
|
10887
|
+
```
|
|
10888
|
+
</dd>
|
|
10889
|
+
</dl>
|
|
10890
|
+
</dd>
|
|
10891
|
+
</dl>
|
|
10892
|
+
|
|
10893
|
+
#### ⚙️ Parameters
|
|
10894
|
+
|
|
10895
|
+
<dl>
|
|
10896
|
+
<dd>
|
|
10897
|
+
|
|
10898
|
+
<dl>
|
|
10899
|
+
<dd>
|
|
10900
|
+
|
|
10901
|
+
**api_key:** `String` — Your API key
|
|
10902
|
+
|
|
10903
|
+
</dd>
|
|
10904
|
+
</dl>
|
|
10905
|
+
|
|
10906
|
+
<dl>
|
|
10907
|
+
<dd>
|
|
10908
|
+
|
|
10909
|
+
**format:** `Apifreaks::Types::GetCitiesRequestFormat` — Format of the response.
|
|
10910
|
+
|
|
10911
|
+
</dd>
|
|
10912
|
+
</dl>
|
|
10913
|
+
|
|
10914
|
+
<dl>
|
|
10915
|
+
<dd>
|
|
10916
|
+
|
|
10917
|
+
**country:** `String` — Country code in ISO 3166-1 alpha-2 format.
|
|
10918
|
+
|
|
10919
|
+
</dd>
|
|
10920
|
+
</dl>
|
|
10921
|
+
|
|
10922
|
+
<dl>
|
|
10923
|
+
<dd>
|
|
10924
|
+
|
|
10925
|
+
**admin_unit:** `String` — Administrative unit code used to filter cities within a specific region.
|
|
10926
|
+
|
|
10927
|
+
</dd>
|
|
10928
|
+
</dl>
|
|
10929
|
+
|
|
10930
|
+
<dl>
|
|
10931
|
+
<dd>
|
|
10932
|
+
|
|
10933
|
+
**request_options:** `Apifreaks::RequestOptions`
|
|
10934
|
+
|
|
10935
|
+
</dd>
|
|
10936
|
+
</dl>
|
|
10937
|
+
</dd>
|
|
10938
|
+
</dl>
|
|
10939
|
+
|
|
10940
|
+
|
|
10941
|
+
</dd>
|
|
10942
|
+
</dl>
|
|
10943
|
+
</details>
|
|
10944
|
+
|
|
10945
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">get_supported_flags</a>() -> Internal::Types::Array[Apifreaks::Types::GetSupportedFlagsResponseItem]</code></summary>
|
|
10946
|
+
<dl>
|
|
10947
|
+
<dd>
|
|
10948
|
+
|
|
10949
|
+
#### 📝 Description
|
|
10950
|
+
|
|
10951
|
+
<dl>
|
|
10952
|
+
<dd>
|
|
10953
|
+
|
|
10954
|
+
<dl>
|
|
10955
|
+
<dd>
|
|
10956
|
+
|
|
10957
|
+
Get list of all supported flags with their metadata
|
|
10958
|
+
</dd>
|
|
10959
|
+
</dl>
|
|
10960
|
+
</dd>
|
|
10961
|
+
</dl>
|
|
10962
|
+
|
|
10963
|
+
#### 🔌 Usage
|
|
10964
|
+
|
|
10965
|
+
<dl>
|
|
10966
|
+
<dd>
|
|
10967
|
+
|
|
10968
|
+
<dl>
|
|
10969
|
+
<dd>
|
|
10970
|
+
|
|
10971
|
+
```ruby
|
|
10972
|
+
client.get_supported_flags(api_key: "apiKey")
|
|
10973
|
+
```
|
|
10402
10974
|
</dd>
|
|
10403
10975
|
</dl>
|
|
10404
|
-
|
|
10405
|
-
<dl>
|
|
10406
|
-
<dd>
|
|
10407
|
-
|
|
10408
|
-
**format:** `Apifreaks::Types::GetAdminUnitDetailsRequestFormat` — Format of the response.
|
|
10409
|
-
|
|
10410
10976
|
</dd>
|
|
10411
10977
|
</dl>
|
|
10412
10978
|
|
|
10979
|
+
#### ⚙️ Parameters
|
|
10980
|
+
|
|
10413
10981
|
<dl>
|
|
10414
10982
|
<dd>
|
|
10415
10983
|
|
|
10416
|
-
**country:** `String` — Country code in ISO 3166-1 alpha-2 format.
|
|
10417
|
-
|
|
10418
|
-
</dd>
|
|
10419
|
-
</dl>
|
|
10420
|
-
|
|
10421
10984
|
<dl>
|
|
10422
10985
|
<dd>
|
|
10423
10986
|
|
|
10424
|
-
**
|
|
10987
|
+
**api_key:** `String` — Your API key
|
|
10425
10988
|
|
|
10426
10989
|
</dd>
|
|
10427
10990
|
</dl>
|
|
@@ -10441,7 +11004,7 @@ client.get_admin_unit_details(
|
|
|
10441
11004
|
</dl>
|
|
10442
11005
|
</details>
|
|
10443
11006
|
|
|
10444
|
-
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">
|
|
11007
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">get_flags</a>() -> String</code></summary>
|
|
10445
11008
|
<dl>
|
|
10446
11009
|
<dd>
|
|
10447
11010
|
|
|
@@ -10453,7 +11016,7 @@ client.get_admin_unit_details(
|
|
|
10453
11016
|
<dl>
|
|
10454
11017
|
<dd>
|
|
10455
11018
|
|
|
10456
|
-
Retrieve
|
|
11019
|
+
Retrieve the flag for a specific country
|
|
10457
11020
|
</dd>
|
|
10458
11021
|
</dl>
|
|
10459
11022
|
</dd>
|
|
@@ -10468,9 +11031,11 @@ Retrieve a list of cities within a country, optionally filtered by an administra
|
|
|
10468
11031
|
<dd>
|
|
10469
11032
|
|
|
10470
11033
|
```ruby
|
|
10471
|
-
client.
|
|
11034
|
+
client.get_flags(
|
|
10472
11035
|
api_key: "apiKey",
|
|
10473
|
-
|
|
11036
|
+
name: "name",
|
|
11037
|
+
shape: "flat",
|
|
11038
|
+
type: "country"
|
|
10474
11039
|
)
|
|
10475
11040
|
```
|
|
10476
11041
|
</dd>
|
|
@@ -10494,7 +11059,7 @@ client.get_cities(
|
|
|
10494
11059
|
<dl>
|
|
10495
11060
|
<dd>
|
|
10496
11061
|
|
|
10497
|
-
**
|
|
11062
|
+
**name:** `String` — Country code in ISO 3166-1 alpha-2 format.
|
|
10498
11063
|
|
|
10499
11064
|
</dd>
|
|
10500
11065
|
</dl>
|
|
@@ -10502,7 +11067,7 @@ client.get_cities(
|
|
|
10502
11067
|
<dl>
|
|
10503
11068
|
<dd>
|
|
10504
11069
|
|
|
10505
|
-
**
|
|
11070
|
+
**shape:** `Apifreaks::Types::GetFlagsRequestShape` — Flag shape. One of: `'flat'` or `'round'`.
|
|
10506
11071
|
|
|
10507
11072
|
</dd>
|
|
10508
11073
|
</dl>
|
|
@@ -10510,7 +11075,23 @@ client.get_cities(
|
|
|
10510
11075
|
<dl>
|
|
10511
11076
|
<dd>
|
|
10512
11077
|
|
|
10513
|
-
**
|
|
11078
|
+
**format:** `Apifreaks::Types::GetFlagsRequestFormat` — Flag format. Applicable only for PNG or WEBP formats. Default is png.
|
|
11079
|
+
|
|
11080
|
+
</dd>
|
|
11081
|
+
</dl>
|
|
11082
|
+
|
|
11083
|
+
<dl>
|
|
11084
|
+
<dd>
|
|
11085
|
+
|
|
11086
|
+
**size:** `Apifreaks::Types::GetFlagsRequestSize` — Flag size in pixels. Valid options: `16px`, `24px`, `32px`, `48px`, `64px`. Applicable only for PNG or WEBP formats.
|
|
11087
|
+
|
|
11088
|
+
</dd>
|
|
11089
|
+
</dl>
|
|
11090
|
+
|
|
11091
|
+
<dl>
|
|
11092
|
+
<dd>
|
|
11093
|
+
|
|
11094
|
+
**type:** `Apifreaks::Types::GetFlagsRequestType` — Type of flag. One of: `country` or `organization`.
|
|
10514
11095
|
|
|
10515
11096
|
</dd>
|
|
10516
11097
|
</dl>
|
|
@@ -10530,7 +11111,7 @@ client.get_cities(
|
|
|
10530
11111
|
</dl>
|
|
10531
11112
|
</details>
|
|
10532
11113
|
|
|
10533
|
-
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">
|
|
11114
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">timezone_lookup</a>() -> Apifreaks::Types::TimezoneLookupResponse</code></summary>
|
|
10534
11115
|
<dl>
|
|
10535
11116
|
<dd>
|
|
10536
11117
|
|
|
@@ -10542,7 +11123,7 @@ client.get_cities(
|
|
|
10542
11123
|
<dl>
|
|
10543
11124
|
<dd>
|
|
10544
11125
|
|
|
10545
|
-
|
|
11126
|
+
Retrieve current time, date, and timezone-related information by specifying a timezone name, location address, location coordinates, IP address, or use the client IP address if no parameter is passed.
|
|
10546
11127
|
</dd>
|
|
10547
11128
|
</dl>
|
|
10548
11129
|
</dd>
|
|
@@ -10557,7 +11138,7 @@ Get list of all supported flags with their metadata
|
|
|
10557
11138
|
<dd>
|
|
10558
11139
|
|
|
10559
11140
|
```ruby
|
|
10560
|
-
client.
|
|
11141
|
+
client.timezone_lookup(api_key: "apiKey")
|
|
10561
11142
|
```
|
|
10562
11143
|
</dd>
|
|
10563
11144
|
</dl>
|
|
@@ -10580,66 +11161,39 @@ client.get_supported_flags(api_key: "apiKey")
|
|
|
10580
11161
|
<dl>
|
|
10581
11162
|
<dd>
|
|
10582
11163
|
|
|
10583
|
-
**
|
|
11164
|
+
**format:** `Apifreaks::Types::TimezoneLookupRequestFormat` — Format of the response
|
|
10584
11165
|
|
|
10585
11166
|
</dd>
|
|
10586
11167
|
</dl>
|
|
10587
|
-
</dd>
|
|
10588
|
-
</dl>
|
|
10589
|
-
|
|
10590
|
-
|
|
10591
|
-
</dd>
|
|
10592
|
-
</dl>
|
|
10593
|
-
</details>
|
|
10594
11168
|
|
|
10595
|
-
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">get_flags</a>() -> String</code></summary>
|
|
10596
11169
|
<dl>
|
|
10597
11170
|
<dd>
|
|
10598
11171
|
|
|
10599
|
-
|
|
10600
|
-
|
|
10601
|
-
|
|
10602
|
-
|
|
11172
|
+
**ip:** `String` — IPv4 or IPv6 address to extract timezone information.
|
|
11173
|
+
|
|
11174
|
+
</dd>
|
|
11175
|
+
</dl>
|
|
10603
11176
|
|
|
10604
11177
|
<dl>
|
|
10605
11178
|
<dd>
|
|
10606
11179
|
|
|
10607
|
-
|
|
10608
|
-
|
|
10609
|
-
</dl>
|
|
11180
|
+
**tz:** `String` — Timezone name (e.g., "Asia/Kolkata") to retrieve information directly.
|
|
11181
|
+
|
|
10610
11182
|
</dd>
|
|
10611
11183
|
</dl>
|
|
10612
11184
|
|
|
10613
|
-
#### 🔌 Usage
|
|
10614
|
-
|
|
10615
|
-
<dl>
|
|
10616
|
-
<dd>
|
|
10617
|
-
|
|
10618
11185
|
<dl>
|
|
10619
11186
|
<dd>
|
|
10620
11187
|
|
|
10621
|
-
|
|
10622
|
-
|
|
10623
|
-
api_key: "apiKey",
|
|
10624
|
-
name: "name",
|
|
10625
|
-
shape: "flat",
|
|
10626
|
-
type: "country"
|
|
10627
|
-
)
|
|
10628
|
-
```
|
|
10629
|
-
</dd>
|
|
10630
|
-
</dl>
|
|
11188
|
+
**location:** `String` — Location string (preferably city and country) to extract timezone.
|
|
11189
|
+
|
|
10631
11190
|
</dd>
|
|
10632
11191
|
</dl>
|
|
10633
11192
|
|
|
10634
|
-
#### ⚙️ Parameters
|
|
10635
|
-
|
|
10636
11193
|
<dl>
|
|
10637
11194
|
<dd>
|
|
10638
11195
|
|
|
10639
|
-
|
|
10640
|
-
<dd>
|
|
10641
|
-
|
|
10642
|
-
**api_key:** `String` — Your API key
|
|
11196
|
+
**lat:** `Integer` — Latitude for geolocation lookup.
|
|
10643
11197
|
|
|
10644
11198
|
</dd>
|
|
10645
11199
|
</dl>
|
|
@@ -10647,7 +11201,7 @@ client.get_flags(
|
|
|
10647
11201
|
<dl>
|
|
10648
11202
|
<dd>
|
|
10649
11203
|
|
|
10650
|
-
**
|
|
11204
|
+
**long:** `Integer` — Longitude for geolocation lookup.
|
|
10651
11205
|
|
|
10652
11206
|
</dd>
|
|
10653
11207
|
</dl>
|
|
@@ -10655,7 +11209,7 @@ client.get_flags(
|
|
|
10655
11209
|
<dl>
|
|
10656
11210
|
<dd>
|
|
10657
11211
|
|
|
10658
|
-
**
|
|
11212
|
+
**lang:** `Apifreaks::Types::TimezoneLookupRequestLang` — Language code for response localization (default is "en").
|
|
10659
11213
|
|
|
10660
11214
|
</dd>
|
|
10661
11215
|
</dl>
|
|
@@ -10663,7 +11217,7 @@ client.get_flags(
|
|
|
10663
11217
|
<dl>
|
|
10664
11218
|
<dd>
|
|
10665
11219
|
|
|
10666
|
-
**
|
|
11220
|
+
**iata_code:** `String` — 3-letter IATA airport code (e.g., JFK).
|
|
10667
11221
|
|
|
10668
11222
|
</dd>
|
|
10669
11223
|
</dl>
|
|
@@ -10671,7 +11225,7 @@ client.get_flags(
|
|
|
10671
11225
|
<dl>
|
|
10672
11226
|
<dd>
|
|
10673
11227
|
|
|
10674
|
-
**
|
|
11228
|
+
**icao_code:** `String` — 4-letter ICAO airport code (e.g., KJFK).
|
|
10675
11229
|
|
|
10676
11230
|
</dd>
|
|
10677
11231
|
</dl>
|
|
@@ -10679,7 +11233,7 @@ client.get_flags(
|
|
|
10679
11233
|
<dl>
|
|
10680
11234
|
<dd>
|
|
10681
11235
|
|
|
10682
|
-
**
|
|
11236
|
+
**lo_code:** `String` — 5-letter UN/LO city code.
|
|
10683
11237
|
|
|
10684
11238
|
</dd>
|
|
10685
11239
|
</dl>
|
|
@@ -10699,7 +11253,7 @@ client.get_flags(
|
|
|
10699
11253
|
</dl>
|
|
10700
11254
|
</details>
|
|
10701
11255
|
|
|
10702
|
-
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">
|
|
11256
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">timezone_lookup_v2</a>() -> Apifreaks::Types::TimezoneLookupResponse</code></summary>
|
|
10703
11257
|
<dl>
|
|
10704
11258
|
<dd>
|
|
10705
11259
|
|
|
@@ -10711,7 +11265,7 @@ client.get_flags(
|
|
|
10711
11265
|
<dl>
|
|
10712
11266
|
<dd>
|
|
10713
11267
|
|
|
10714
|
-
Retrieve current time, date, and timezone-related information by specifying a timezone name, location address, location coordinates, IP address, or use the client IP address if no parameter is passed.
|
|
11268
|
+
Retrieve current time, date, and timezone-related information using the `v2.0/geolocation/timezone` endpoint by specifying a timezone name, location address, location coordinates, IP address, or use the client IP address if no parameter is passed.
|
|
10715
11269
|
</dd>
|
|
10716
11270
|
</dl>
|
|
10717
11271
|
</dd>
|
|
@@ -10726,7 +11280,7 @@ Retrieve current time, date, and timezone-related information by specifying a ti
|
|
|
10726
11280
|
<dd>
|
|
10727
11281
|
|
|
10728
11282
|
```ruby
|
|
10729
|
-
client.
|
|
11283
|
+
client.timezone_lookup_v2(api_key: "apiKey")
|
|
10730
11284
|
```
|
|
10731
11285
|
</dd>
|
|
10732
11286
|
</dl>
|
|
@@ -11089,6 +11643,14 @@ client.user_agent_lookup(api_key: "apiKey")
|
|
|
11089
11643
|
<dl>
|
|
11090
11644
|
<dd>
|
|
11091
11645
|
|
|
11646
|
+
**user_agent:** `String` — The User-Agent string to parse. Sent as the `User-Agent` HTTP header. **Required**
|
|
11647
|
+
|
|
11648
|
+
</dd>
|
|
11649
|
+
</dl>
|
|
11650
|
+
|
|
11651
|
+
<dl>
|
|
11652
|
+
<dd>
|
|
11653
|
+
|
|
11092
11654
|
**request_options:** `Apifreaks::RequestOptions`
|
|
11093
11655
|
|
|
11094
11656
|
</dd>
|
|
@@ -11778,3 +12340,137 @@ client.astronomy_lookup(api_key: "apiKey")
|
|
|
11778
12340
|
</dl>
|
|
11779
12341
|
</details>
|
|
11780
12342
|
|
|
12343
|
+
<details><summary><code>client.<a href="/lib/apifreaks/client.rb">astronomy_lookup_v2</a>() -> Apifreaks::Types::AstronomyLookupResponse</code></summary>
|
|
12344
|
+
<dl>
|
|
12345
|
+
<dd>
|
|
12346
|
+
|
|
12347
|
+
#### 📝 Description
|
|
12348
|
+
|
|
12349
|
+
<dl>
|
|
12350
|
+
<dd>
|
|
12351
|
+
|
|
12352
|
+
<dl>
|
|
12353
|
+
<dd>
|
|
12354
|
+
|
|
12355
|
+
Retrieve sunrise and sunset times, current position of the moon, and other related information using the `v2.0/geolocation/astronomy` endpoint by specifying a location address, location coordinates, IP address, or using the client IP address if no parameter is passed.
|
|
12356
|
+
</dd>
|
|
12357
|
+
</dl>
|
|
12358
|
+
</dd>
|
|
12359
|
+
</dl>
|
|
12360
|
+
|
|
12361
|
+
#### 🔌 Usage
|
|
12362
|
+
|
|
12363
|
+
<dl>
|
|
12364
|
+
<dd>
|
|
12365
|
+
|
|
12366
|
+
<dl>
|
|
12367
|
+
<dd>
|
|
12368
|
+
|
|
12369
|
+
```ruby
|
|
12370
|
+
client.astronomy_lookup_v2(api_key: "apiKey")
|
|
12371
|
+
```
|
|
12372
|
+
</dd>
|
|
12373
|
+
</dl>
|
|
12374
|
+
</dd>
|
|
12375
|
+
</dl>
|
|
12376
|
+
|
|
12377
|
+
#### ⚙️ Parameters
|
|
12378
|
+
|
|
12379
|
+
<dl>
|
|
12380
|
+
<dd>
|
|
12381
|
+
|
|
12382
|
+
<dl>
|
|
12383
|
+
<dd>
|
|
12384
|
+
|
|
12385
|
+
**api_key:** `String` — Your API key
|
|
12386
|
+
|
|
12387
|
+
</dd>
|
|
12388
|
+
</dl>
|
|
12389
|
+
|
|
12390
|
+
<dl>
|
|
12391
|
+
<dd>
|
|
12392
|
+
|
|
12393
|
+
**format:** `Apifreaks::Types::AstronomyLookupRequestFormat` — Format of the response.
|
|
12394
|
+
|
|
12395
|
+
</dd>
|
|
12396
|
+
</dl>
|
|
12397
|
+
|
|
12398
|
+
<dl>
|
|
12399
|
+
<dd>
|
|
12400
|
+
|
|
12401
|
+
**location:** `String` — Location name or address
|
|
12402
|
+
|
|
12403
|
+
</dd>
|
|
12404
|
+
</dl>
|
|
12405
|
+
|
|
12406
|
+
<dl>
|
|
12407
|
+
<dd>
|
|
12408
|
+
|
|
12409
|
+
**lat:** `Integer` — Latitude for location coordinates
|
|
12410
|
+
|
|
12411
|
+
</dd>
|
|
12412
|
+
</dl>
|
|
12413
|
+
|
|
12414
|
+
<dl>
|
|
12415
|
+
<dd>
|
|
12416
|
+
|
|
12417
|
+
**long:** `Integer` — Longitude for location coordinates
|
|
12418
|
+
|
|
12419
|
+
</dd>
|
|
12420
|
+
</dl>
|
|
12421
|
+
|
|
12422
|
+
<dl>
|
|
12423
|
+
<dd>
|
|
12424
|
+
|
|
12425
|
+
**ip:** `String` — IP address for location detection
|
|
12426
|
+
|
|
12427
|
+
</dd>
|
|
12428
|
+
</dl>
|
|
12429
|
+
|
|
12430
|
+
<dl>
|
|
12431
|
+
<dd>
|
|
12432
|
+
|
|
12433
|
+
**lang:** `String`
|
|
12434
|
+
|
|
12435
|
+
</dd>
|
|
12436
|
+
</dl>
|
|
12437
|
+
|
|
12438
|
+
<dl>
|
|
12439
|
+
<dd>
|
|
12440
|
+
|
|
12441
|
+
**date:** `String` — Date for astronomy data (YYYY-MM-DD)
|
|
12442
|
+
|
|
12443
|
+
</dd>
|
|
12444
|
+
</dl>
|
|
12445
|
+
|
|
12446
|
+
<dl>
|
|
12447
|
+
<dd>
|
|
12448
|
+
|
|
12449
|
+
**elevation:** `Integer` — Timezone of the location for which astronomy data is required
|
|
12450
|
+
|
|
12451
|
+
</dd>
|
|
12452
|
+
</dl>
|
|
12453
|
+
|
|
12454
|
+
<dl>
|
|
12455
|
+
<dd>
|
|
12456
|
+
|
|
12457
|
+
**time_zone:** `String` —
|
|
12458
|
+
|
|
12459
|
+
</dd>
|
|
12460
|
+
</dl>
|
|
12461
|
+
|
|
12462
|
+
<dl>
|
|
12463
|
+
<dd>
|
|
12464
|
+
|
|
12465
|
+
**request_options:** `Apifreaks::RequestOptions`
|
|
12466
|
+
|
|
12467
|
+
</dd>
|
|
12468
|
+
</dl>
|
|
12469
|
+
</dd>
|
|
12470
|
+
</dl>
|
|
12471
|
+
|
|
12472
|
+
|
|
12473
|
+
</dd>
|
|
12474
|
+
</dl>
|
|
12475
|
+
</details>
|
|
12476
|
+
|