@apifreaks/openapi-specs 0.2.0 → 0.3.0

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 (212) hide show
  1. package/README.md +37 -37
  2. package/dist/index.cjs +2787 -348
  3. package/dist/index.js +2787 -348
  4. package/dist/specs/commodity/commodity-fluctuation.yaml +14 -0
  5. package/dist/specs/commodity/commodity-prices.yaml +14 -0
  6. package/dist/specs/commodity/commodity-symbols.yaml +8 -0
  7. package/dist/specs/commodity/commodity-time-series.yaml +14 -0
  8. package/dist/specs/commodity/historical-commodity-prices.yaml +14 -0
  9. package/dist/specs/currency/currency-converter.yaml +14 -0
  10. package/dist/specs/currency/currency-fluctuation.yaml +14 -0
  11. package/dist/specs/currency/currency-historical-data-limit.yaml +11 -0
  12. package/dist/specs/currency/currency-rate.yaml +14 -0
  13. package/dist/specs/currency/currency-supported.yaml +11 -0
  14. package/dist/specs/currency/currency-symbols.yaml +11 -0
  15. package/dist/specs/currency/currency-time-series.yaml +14 -0
  16. package/dist/specs/currency/geolocalized-currency-conversion.yaml +14 -0
  17. package/dist/specs/currency/historical-currency-converter.yaml +14 -0
  18. package/dist/specs/currency/historical-currency-rate.yaml +14 -0
  19. package/dist/specs/dns/bulk-dns-lookup.yaml +14 -0
  20. package/dist/specs/dns/dns-history-lookup.yaml +14 -0
  21. package/dist/specs/dns/dns-lookup.yaml +11 -0
  22. package/dist/specs/dns/reverse-dns-lookup.yaml +34 -0
  23. package/dist/specs/domain/bulk-domain-checker.yaml +17 -0
  24. package/dist/specs/domain/domain-search-with-suggestions.yaml +14 -0
  25. package/dist/specs/domain/domain-search.yaml +14 -0
  26. package/dist/specs/domain/subdomain-lookup.yaml +14 -0
  27. package/dist/specs/email-validation/bulk-email-validation.yaml +17 -0
  28. package/dist/specs/email-validation/email-checker.yaml +41 -0
  29. package/dist/specs/financial/bulk-vat-rates-country.yaml +14 -0
  30. package/dist/specs/financial/financial-apis-supported-countries.yaml +8 -0
  31. package/dist/specs/financial/iban-validation.yaml +11 -0
  32. package/dist/specs/financial/swift-code-finder.yaml +11 -0
  33. package/dist/specs/financial/swift-code-lookup.yaml +14 -0
  34. package/dist/specs/financial/vat-number-validation.yaml +14 -0
  35. package/dist/specs/financial/vat-rates-by-ip.yaml +14 -0
  36. package/dist/specs/financial/vat-rates-country.yaml +14 -0
  37. package/dist/specs/general/usage-credits.yaml +11 -0
  38. package/dist/specs/geocoding/forward-geocoding.yaml +14 -0
  39. package/dist/specs/geocoding/reverse-geocoding.yaml +11 -0
  40. package/dist/specs/geodb/administrative-units-details.yaml +14 -0
  41. package/dist/specs/geodb/administrative-units-levels.yaml +14 -0
  42. package/dist/specs/geodb/administrative-units.yaml +14 -0
  43. package/dist/specs/geodb/cities.yaml +14 -0
  44. package/dist/specs/geodb/countries-details.yaml +11 -0
  45. package/dist/specs/geodb/countries.yaml +11 -0
  46. package/dist/specs/geodb/flags-supported.yaml +8 -0
  47. package/dist/specs/geodb/flags.yaml +14 -0
  48. package/dist/specs/geodb/regions.yaml +8 -0
  49. package/dist/specs/geodb/subregions.yaml +14 -0
  50. package/dist/specs/ip-intelligence/bulk-ip-lookup.yaml +14 -0
  51. package/dist/specs/ip-intelligence/bulk-ip-threat-intelligence.yaml +11 -0
  52. package/dist/specs/ip-intelligence/ip-locator.yaml +17 -0
  53. package/dist/specs/ip-intelligence/ip-threat-intelligence.yaml +14 -0
  54. package/dist/specs/other/astronomy-data.yaml +14 -0
  55. package/dist/specs/pdf/bulk-pdf-generator.yaml +32 -0
  56. package/dist/specs/pdf/delete-pdf-page.yaml +14 -0
  57. package/dist/specs/pdf/linearize-pdf.yaml +14 -0
  58. package/dist/specs/pdf/merge-pdf.yaml +14 -0
  59. package/dist/specs/pdf/pdf-compress.yaml +14 -0
  60. package/dist/specs/pdf/pdf-decrypt.yaml +14 -0
  61. package/dist/specs/pdf/pdf-encrypt.yaml +14 -0
  62. package/dist/specs/pdf/pdf-extract-pages.yaml +14 -0
  63. package/dist/specs/pdf/pdf-file-status.yaml +14 -0
  64. package/dist/specs/pdf/pdf-file.yaml +14 -0
  65. package/dist/specs/pdf/pdf-files.yaml +8 -0
  66. package/dist/specs/pdf/pdf-generator.yaml +32 -0
  67. package/dist/specs/pdf/pdf-resource-download.yaml +14 -0
  68. package/dist/specs/pdf/pdf-resource-upload-binary.yaml +14 -0
  69. package/dist/specs/pdf/pdf-resource-upload.yaml +14 -0
  70. package/dist/specs/pdf/pdf-restrict.yaml +14 -0
  71. package/dist/specs/pdf/pdf-split-pages.yaml +14 -0
  72. package/dist/specs/pdf/pdf-task-status.yaml +14 -0
  73. package/dist/specs/pdf/pdf-to-image.yaml +35 -0
  74. package/dist/specs/pdf/pdf-unrestrict.yaml +14 -0
  75. package/dist/specs/pdf/rotate-pdf-pages.yaml +14 -0
  76. package/dist/specs/phone-validation/bulk-phone-number-validation.yaml +23 -0
  77. package/dist/specs/phone-validation/phone-number-validation.yaml +20 -0
  78. package/dist/specs/scraper/web-scraper.yaml +34 -0
  79. package/dist/specs/screenshot/bulk-screenshot.yaml +34 -0
  80. package/dist/specs/screenshot/website-screenshot.yaml +34 -0
  81. package/dist/specs/ssl/ssl-certificate-chain-lookup.yaml +17 -0
  82. package/dist/specs/ssl/ssl-certificate-lookup.yaml +17 -0
  83. package/dist/specs/timezone/timezone-converter.yaml +14 -0
  84. package/dist/specs/timezone/timezone-lookup.yaml +14 -0
  85. package/dist/specs/user-agent/bulk-user-agent-parser.yaml +11 -0
  86. package/dist/specs/user-agent/user-agent-parser.yaml +11 -0
  87. package/dist/specs/weather/air-quality.yaml +14 -0
  88. package/dist/specs/weather/bulk-live-weather.yaml +11 -0
  89. package/dist/specs/weather/flood-forecast.yaml +14 -0
  90. package/dist/specs/weather/historical-weather.yaml +14 -0
  91. package/dist/specs/weather/live-weather.yaml +14 -0
  92. package/dist/specs/weather/marine-weather.yaml +14 -0
  93. package/dist/specs/weather/time-series-weather.yaml +11 -0
  94. package/dist/specs/weather/weather-forecast.yaml +11 -0
  95. package/dist/specs/whois/asn-lookup.yaml +14 -0
  96. package/dist/specs/whois/bulk-whois-lookup.yaml +17 -0
  97. package/dist/specs/whois/domain-whois-history-lookup.yaml +14 -0
  98. package/dist/specs/whois/reverse-whois.yaml +34 -0
  99. package/dist/specs/whois/whois-domain-lookup.yaml +17 -0
  100. package/dist/specs/whois/whois-ip-lookup.yaml +14 -0
  101. package/dist/specs/zip-code/bulk-zip-code-lookup.yaml +14 -0
  102. package/dist/specs/zip-code/zip-code-api.yaml +14 -0
  103. package/dist/specs/zip-code/zip-code-distance-match.yaml +14 -0
  104. package/dist/specs/zip-code/zip-code-distance.yaml +14 -0
  105. package/dist/specs/zip-code/zip-codes-by-city.yaml +14 -0
  106. package/dist/specs/zip-code/zip-codes-by-region.yaml +14 -0
  107. package/dist/specs/zip-code/zip-codes-radius-search.yaml +34 -0
  108. package/package.json +1 -1
  109. package/specs/commodity/commodity-fluctuation.json +23 -0
  110. package/specs/commodity/commodity-prices.json +23 -0
  111. package/specs/commodity/commodity-symbols.json +13 -0
  112. package/specs/commodity/commodity-time-series.json +27 -13
  113. package/specs/commodity/historical-commodity-prices.json +23 -0
  114. package/specs/currency/currency-converter.json +23 -0
  115. package/specs/currency/currency-fluctuation.json +23 -0
  116. package/specs/currency/currency-historical-data-limit.json +18 -0
  117. package/specs/currency/currency-rate.json +23 -0
  118. package/specs/currency/currency-supported.json +18 -0
  119. package/specs/currency/currency-symbols.json +18 -0
  120. package/specs/currency/currency-time-series.json +23 -0
  121. package/specs/currency/geolocalized-currency-conversion.json +23 -0
  122. package/specs/currency/historical-currency-converter.json +23 -0
  123. package/specs/currency/historical-currency-rate.json +23 -0
  124. package/specs/dns/bulk-dns-lookup.json +23 -0
  125. package/specs/dns/dns-history-lookup.json +23 -0
  126. package/specs/dns/dns-lookup.json +18 -0
  127. package/specs/dns/reverse-dns-lookup.json +61 -1
  128. package/specs/domain/bulk-domain-checker.json +28 -0
  129. package/specs/domain/domain-search-with-suggestions.json +23 -0
  130. package/specs/domain/domain-search.json +23 -0
  131. package/specs/domain/subdomain-lookup.json +23 -0
  132. package/specs/email-validation/bulk-email-validation.json +28 -0
  133. package/specs/email-validation/email-checker.json +64 -0
  134. package/specs/financial/bulk-vat-rates-country.json +23 -0
  135. package/specs/financial/financial-apis-supported-countries.json +34 -5
  136. package/specs/financial/iban-validation.json +18 -0
  137. package/specs/financial/swift-code-finder.json +31 -2
  138. package/specs/financial/swift-code-lookup.json +23 -0
  139. package/specs/financial/vat-number-validation.json +23 -0
  140. package/specs/financial/vat-rates-by-ip.json +23 -0
  141. package/specs/financial/vat-rates-country.json +23 -0
  142. package/specs/general/usage-credits.json +18 -0
  143. package/specs/geocoding/forward-geocoding.json +23 -0
  144. package/specs/geocoding/reverse-geocoding.json +18 -0
  145. package/specs/geodb/administrative-units-details.json +23 -0
  146. package/specs/geodb/administrative-units-levels.json +23 -0
  147. package/specs/geodb/administrative-units.json +23 -0
  148. package/specs/geodb/cities.json +23 -0
  149. package/specs/geodb/countries-details.json +18 -0
  150. package/specs/geodb/countries.json +18 -0
  151. package/specs/geodb/flags-supported.json +13 -0
  152. package/specs/geodb/flags.json +23 -0
  153. package/specs/geodb/regions.json +13 -0
  154. package/specs/geodb/subregions.json +23 -0
  155. package/specs/ip-intelligence/bulk-ip-lookup.json +23 -0
  156. package/specs/ip-intelligence/bulk-ip-threat-intelligence.json +18 -0
  157. package/specs/ip-intelligence/ip-locator.json +33 -5
  158. package/specs/ip-intelligence/ip-threat-intelligence.json +23 -0
  159. package/specs/other/astronomy-data.json +24 -2
  160. package/specs/pdf/bulk-pdf-generator.json +61 -8
  161. package/specs/pdf/delete-pdf-page.json +33 -21
  162. package/specs/pdf/linearize-pdf.json +31 -19
  163. package/specs/pdf/merge-pdf.json +30 -18
  164. package/specs/pdf/pdf-compress.json +32 -25
  165. package/specs/pdf/pdf-decrypt.json +32 -21
  166. package/specs/pdf/pdf-encrypt.json +31 -19
  167. package/specs/pdf/pdf-extract-pages.json +33 -21
  168. package/specs/pdf/pdf-file-status.json +23 -0
  169. package/specs/pdf/pdf-file.json +23 -0
  170. package/specs/pdf/pdf-files.json +13 -0
  171. package/specs/pdf/pdf-generator.json +61 -8
  172. package/specs/pdf/pdf-resource-download.json +23 -0
  173. package/specs/pdf/pdf-resource-upload-binary.json +29 -16
  174. package/specs/pdf/pdf-resource-upload.json +30 -19
  175. package/specs/pdf/pdf-restrict.json +32 -20
  176. package/specs/pdf/pdf-split-pages.json +33 -21
  177. package/specs/pdf/pdf-task-status.json +23 -0
  178. package/specs/pdf/pdf-to-image.json +90 -101
  179. package/specs/pdf/pdf-unrestrict.json +32 -20
  180. package/specs/pdf/rotate-pdf-pages.json +32 -20
  181. package/specs/phone-validation/bulk-phone-number-validation.json +54 -16
  182. package/specs/phone-validation/phone-number-validation.json +33 -0
  183. package/specs/scraper/web-scraper.json +53 -0
  184. package/specs/screenshot/bulk-screenshot.json +53 -0
  185. package/specs/screenshot/website-screenshot.json +53 -0
  186. package/specs/ssl/ssl-certificate-chain-lookup.json +28 -0
  187. package/specs/ssl/ssl-certificate-lookup.json +28 -0
  188. package/specs/timezone/timezone-converter.json +23 -0
  189. package/specs/timezone/timezone-lookup.json +25 -2
  190. package/specs/user-agent/bulk-user-agent-parser.json +20 -2
  191. package/specs/user-agent/user-agent-parser.json +18 -0
  192. package/specs/weather/air-quality.json +23 -0
  193. package/specs/weather/bulk-live-weather.json +18 -0
  194. package/specs/weather/flood-forecast.json +23 -0
  195. package/specs/weather/historical-weather.json +23 -0
  196. package/specs/weather/live-weather.json +23 -0
  197. package/specs/weather/marine-weather.json +23 -0
  198. package/specs/weather/time-series-weather.json +18 -0
  199. package/specs/weather/weather-forecast.json +18 -0
  200. package/specs/whois/asn-lookup.json +23 -0
  201. package/specs/whois/bulk-whois-lookup.json +28 -0
  202. package/specs/whois/domain-whois-history-lookup.json +23 -0
  203. package/specs/whois/reverse-whois.json +53 -0
  204. package/specs/whois/whois-domain-lookup.json +28 -0
  205. package/specs/whois/whois-ip-lookup.json +23 -0
  206. package/specs/zip-code/bulk-zip-code-lookup.json +23 -0
  207. package/specs/zip-code/zip-code-api.json +23 -0
  208. package/specs/zip-code/zip-code-distance-match.json +23 -0
  209. package/specs/zip-code/zip-code-distance.json +23 -0
  210. package/specs/zip-code/zip-codes-by-city.json +23 -0
  211. package/specs/zip-code/zip-codes-by-region.json +24 -7
  212. package/specs/zip-code/zip-codes-radius-search.json +53 -0
@@ -175,6 +175,9 @@ paths:
175
175
  rawText: "8.8.8.8.in-addr.arpa.\t16954\tIN\tPTR\tdns.google."
176
176
  rRsetType: 12
177
177
  singleName: dns.google.
178
+ headers:
179
+ X-AF-Credits-Cost:
180
+ $ref: '#/components/headers/X-AF-Credits-Cost'
178
181
  '400':
179
182
  description: Bad Request — Missing or invalid parameters
180
183
  content:
@@ -206,6 +209,9 @@ paths:
206
209
  error: Invalid Param Exception
207
210
  message: 'Please pass domain param correct value[For Technical Support: support@whoisfreaks.com]'
208
211
  path: /v2.0/dns/live
212
+ headers:
213
+ X-AF-Credits-Cost:
214
+ $ref: '#/components/headers/X-AF-Credits-Cost'
209
215
  components:
210
216
  securitySchemes:
211
217
  ApiKeyAuthHeader:
@@ -355,6 +361,11 @@ components:
355
361
  type: string
356
362
  format: date-time
357
363
  description: Timestamp when the error occurred (ISO 8601).
364
+ headers:
365
+ X-AF-Credits-Cost:
366
+ description: Specifies the number of credits consumed by the current request.
367
+ schema:
368
+ type: integer
358
369
  security:
359
370
  - ApiKeyAuthHeader: []
360
371
  - ApiKeyAuthQuery: []
@@ -124,6 +124,13 @@ paths:
124
124
  rawText: "www.hailibu.cn.\t\t1\tIN\tA\t8.8.8.8"
125
125
  rRsetType: 1
126
126
  address: 8.8.8.8
127
+ headers:
128
+ X-AF-Credits-Cost:
129
+ $ref: '#/components/headers/X-AF-Credits-Cost'
130
+ X-Concurrent-Threads:
131
+ $ref: '#/components/headers/X-Concurrent-Threads'
132
+ X-Concurrent-Threads-Active:
133
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
127
134
  '400':
128
135
  description: Invalid DNS type or missing required parameter
129
136
  content:
@@ -147,6 +154,13 @@ paths:
147
154
  path: /v1.0/domain/dns/reverse
148
155
  status: 400
149
156
  timestamp: '2026-07-23T09:51:58.951Z'
157
+ headers:
158
+ X-AF-Credits-Cost:
159
+ $ref: '#/components/headers/X-AF-Credits-Cost'
160
+ X-Concurrent-Threads:
161
+ $ref: '#/components/headers/X-Concurrent-Threads'
162
+ X-Concurrent-Threads-Active:
163
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
150
164
  '404':
151
165
  description: No reverse DNS records found for the given input
152
166
  content:
@@ -162,6 +176,13 @@ paths:
162
176
  status: 404
163
177
  error: Record not Found
164
178
  message: 'No Record Found across: zzsuperrandomnonexistentmxprovider99988.com'
179
+ headers:
180
+ X-AF-Credits-Cost:
181
+ $ref: '#/components/headers/X-AF-Credits-Cost'
182
+ X-Concurrent-Threads:
183
+ $ref: '#/components/headers/X-Concurrent-Threads'
184
+ X-Concurrent-Threads-Active:
185
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
165
186
  components:
166
187
  securitySchemes:
167
188
  ApiKeyAuthHeader:
@@ -333,6 +354,19 @@ components:
333
354
  description: Verification or policy strings. Present only when dnsType is TXT or SPF.
334
355
  items:
335
356
  type: string
357
+ headers:
358
+ X-AF-Credits-Cost:
359
+ description: Specifies the number of credits consumed by the current request.
360
+ schema:
361
+ type: integer
362
+ X-Concurrent-Threads:
363
+ description: Specifies the maximum number of concurrent requests allowed.
364
+ schema:
365
+ type: integer
366
+ X-Concurrent-Threads-Active:
367
+ description: Indicates the number of active concurrent requests being processed.
368
+ schema:
369
+ type: integer
336
370
  security:
337
371
  - ApiKeyAuthHeader: []
338
372
  - ApiKeyAuthQuery: []
@@ -71,6 +71,9 @@ paths:
71
71
  - domain: thisdomainisdefinitelyavailablexyz123abc.com
72
72
  domainAvailability: true
73
73
  status: true
74
+ headers:
75
+ X-AF-Credits-Cost:
76
+ $ref: '#/components/headers/X-AF-Credits-Cost'
74
77
  '206':
75
78
  description: Partial Success — one or more domains in the batch failed to resolve. Failed entries have status false and no domainAvailability field. Even a batch where every domain fails still returns 206, not an error status.
76
79
  content:
@@ -89,6 +92,9 @@ paths:
89
92
  status: true
90
93
  - domain: test.an
91
94
  status: false
95
+ headers:
96
+ X-AF-Credits-Cost:
97
+ $ref: '#/components/headers/X-AF-Credits-Cost'
92
98
  '400':
93
99
  description: Bad Request — Missing or malformed request body
94
100
  content:
@@ -104,6 +110,9 @@ paths:
104
110
  path: /v1.0/domain/availability
105
111
  status: 400
106
112
  timestamp: '2026-07-27T12:23:33.394Z'
113
+ headers:
114
+ X-AF-Credits-Cost:
115
+ $ref: '#/components/headers/X-AF-Credits-Cost'
107
116
  '413':
108
117
  description: Payload Too Large — Request body exceeds the size limit
109
118
  content:
@@ -119,6 +128,9 @@ paths:
119
128
  path: /v1.0/domain/availability
120
129
  status: 413
121
130
  timestamp: '2026-07-27T12:23:46.923Z'
131
+ headers:
132
+ X-AF-Credits-Cost:
133
+ $ref: '#/components/headers/X-AF-Credits-Cost'
122
134
  components:
123
135
  securitySchemes:
124
136
  ApiKeyAuthHeader:
@@ -193,6 +205,11 @@ components:
193
205
  type: string
194
206
  format: date-time
195
207
  description: Timestamp when the error occurred (ISO 8601).
208
+ headers:
209
+ X-AF-Credits-Cost:
210
+ description: Specifies the number of credits consumed by the current request.
211
+ schema:
212
+ type: integer
196
213
  security:
197
214
  - ApiKeyAuthHeader: []
198
215
  - ApiKeyAuthQuery: []
@@ -88,6 +88,9 @@ paths:
88
88
  value:
89
89
  domain: quixoticbramble77.com
90
90
  domainAvailability: true
91
+ headers:
92
+ X-AF-Credits-Cost:
93
+ $ref: '#/components/headers/X-AF-Credits-Cost'
91
94
  '400':
92
95
  description: Bad Request – Invalid domain parameter
93
96
  content:
@@ -103,6 +106,9 @@ paths:
103
106
  path: /v1.0/domain/availability/suggestions
104
107
  status: 400
105
108
  timestamp: '2026-07-27T12:19:46.594Z'
109
+ headers:
110
+ X-AF-Credits-Cost:
111
+ $ref: '#/components/headers/X-AF-Credits-Cost'
106
112
  '408':
107
113
  description: Request Timeout – Unable to fetch WHOIS data
108
114
  content:
@@ -118,6 +124,9 @@ paths:
118
124
  error: Request Timeout
119
125
  message: 'Unable to fetch whois data. Please try again. [For Technical Support email at: support@apifreaks.com]'
120
126
  path: /v1.0/domain/availability/suggestions
127
+ headers:
128
+ X-AF-Credits-Cost:
129
+ $ref: '#/components/headers/X-AF-Credits-Cost'
121
130
  operationId: suggestDomainAvailability
122
131
  components:
123
132
  securitySchemes:
@@ -191,6 +200,11 @@ components:
191
200
  type: string
192
201
  format: date-time
193
202
  description: Timestamp when the error occurred (ISO 8601).
203
+ headers:
204
+ X-AF-Credits-Cost:
205
+ description: Specifies the number of credits consumed by the current request.
206
+ schema:
207
+ type: integer
194
208
  security:
195
209
  - ApiKeyAuthHeader: []
196
210
  - ApiKeyAuthQuery: []
@@ -57,6 +57,9 @@ paths:
57
57
  value:
58
58
  domain: google.com
59
59
  domainAvailability: false
60
+ headers:
61
+ X-AF-Credits-Cost:
62
+ $ref: '#/components/headers/X-AF-Credits-Cost'
60
63
  '400':
61
64
  description: Bad Request – Missing domain, or domain has an unrecognized/unsupported TLD
62
65
  content:
@@ -80,6 +83,9 @@ paths:
80
83
  error: Invalid Param Exception
81
84
  message: 'Please pass domain param correct value [For Technical Support: support@whoisfreaks.com]'
82
85
  path: /v1.0/domain/availability
86
+ headers:
87
+ X-AF-Credits-Cost:
88
+ $ref: '#/components/headers/X-AF-Credits-Cost'
83
89
  '408':
84
90
  description: Request Timeout – Unable to fetch WHOIS data
85
91
  content:
@@ -95,6 +101,9 @@ paths:
95
101
  error: Request Timeout
96
102
  message: 'Unable to fetch whois data. Please try again. [For Technical Support email at: support@apifreaks.com]'
97
103
  path: /v1.0/domain/availability
104
+ headers:
105
+ X-AF-Credits-Cost:
106
+ $ref: '#/components/headers/X-AF-Credits-Cost'
98
107
  operationId: checkDomainAvailability
99
108
  components:
100
109
  securitySchemes:
@@ -144,6 +153,11 @@ components:
144
153
  type: string
145
154
  format: date-time
146
155
  description: Timestamp when the error occurred (ISO 8601).
156
+ headers:
157
+ X-AF-Credits-Cost:
158
+ description: Specifies the number of credits consumed by the current request.
159
+ schema:
160
+ type: integer
147
161
  security:
148
162
  - ApiKeyAuthHeader: []
149
163
  - ApiKeyAuthQuery: []
@@ -91,6 +91,9 @@ paths:
91
91
  - subdomain: www.reusablesec.sites.google.com
92
92
  first_seen: '2020-02-18'
93
93
  last_seen: '2026-06-20'
94
+ headers:
95
+ X-AF-Credits-Cost:
96
+ $ref: '#/components/headers/X-AF-Credits-Cost'
94
97
  '400':
95
98
  description: Bad Request – one or more parameters are invalid
96
99
  content:
@@ -138,6 +141,9 @@ paths:
138
141
  error: Invalid Param Exception
139
142
  message: before date cannot be greater than the current date.
140
143
  path: /v1.0/subdomains
144
+ headers:
145
+ X-AF-Credits-Cost:
146
+ $ref: '#/components/headers/X-AF-Credits-Cost'
141
147
  '408':
142
148
  description: Request Timeout – Unable to fetch WHOIS data
143
149
  content:
@@ -153,6 +159,9 @@ paths:
153
159
  error: Request Timeout
154
160
  message: 'Unable to fetch whois data. Please try again. [For Technical Support email at: support@apifreaks.com]'
155
161
  path: /v1.0/subdomains/lookup
162
+ headers:
163
+ X-AF-Credits-Cost:
164
+ $ref: '#/components/headers/X-AF-Credits-Cost'
156
165
  operationId: lookupSubdomains
157
166
  components:
158
167
  securitySchemes:
@@ -246,6 +255,11 @@ components:
246
255
  type: string
247
256
  format: date-time
248
257
  description: Timestamp when the error occurred (ISO 8601).
258
+ headers:
259
+ X-AF-Credits-Cost:
260
+ description: Specifies the number of credits consumed by the current request.
261
+ schema:
262
+ type: integer
249
263
  security:
250
264
  - ApiKeyAuthHeader: []
251
265
  - ApiKeyAuthQuery: []
@@ -74,6 +74,9 @@ paths:
74
74
  domain:
75
75
  name: not-an-email
76
76
  validDomain: false
77
+ headers:
78
+ X-AF-Credits-Cost:
79
+ $ref: '#/components/headers/X-AF-Credits-Cost'
77
80
  '400':
78
81
  description: Bad Request – Invalid request body
79
82
  content:
@@ -89,6 +92,9 @@ paths:
89
92
  status: 400
90
93
  error: Invalid request body Exception
91
94
  message: Please provide data in required format in request body
95
+ headers:
96
+ X-AF-Credits-Cost:
97
+ $ref: '#/components/headers/X-AF-Credits-Cost'
92
98
  '408':
93
99
  description: Request Timeout
94
100
  content:
@@ -103,6 +109,9 @@ paths:
103
109
  status: 408
104
110
  error: Request Timeout
105
111
  message: Timed out while connecting to the remote URL.
112
+ headers:
113
+ X-AF-Credits-Cost:
114
+ $ref: '#/components/headers/X-AF-Credits-Cost'
106
115
  '429':
107
116
  description: Rate Limit Exceeded
108
117
  content:
@@ -117,6 +126,9 @@ paths:
117
126
  status: 429
118
127
  error: Too Many Requests
119
128
  message: API rate limit exceeded.
129
+ headers:
130
+ X-AF-Credits-Cost:
131
+ $ref: '#/components/headers/X-AF-Credits-Cost'
120
132
  operationId: bulkCheckEmail
121
133
  components:
122
134
  securitySchemes:
@@ -398,6 +410,11 @@ components:
398
410
  type: string
399
411
  format: date-time
400
412
  description: Timestamp when the error occurred (ISO 8601).
413
+ headers:
414
+ X-AF-Credits-Cost:
415
+ description: Specifies the number of credits consumed by the current request.
416
+ schema:
417
+ type: integer
401
418
  security:
402
419
  - ApiKeyAuthHeader: []
403
420
  - ApiKeyAuthQuery: []
@@ -145,6 +145,13 @@ paths:
145
145
  is_bot: false
146
146
  is_cloud_provider: true
147
147
  cloud_provider: Google LLC
148
+ headers:
149
+ X-AF-Credits-Cost:
150
+ $ref: '#/components/headers/X-AF-Credits-Cost'
151
+ X-Concurrent-Threads:
152
+ $ref: '#/components/headers/X-Concurrent-Threads'
153
+ X-Concurrent-Threads-Active:
154
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
148
155
  '400':
149
156
  description: Bad Request – Invalid request body
150
157
  content:
@@ -160,6 +167,13 @@ paths:
160
167
  status: 400
161
168
  error: External API Error
162
169
  message: Please pass valid value for 'email' in body.
170
+ headers:
171
+ X-AF-Credits-Cost:
172
+ $ref: '#/components/headers/X-AF-Credits-Cost'
173
+ X-Concurrent-Threads:
174
+ $ref: '#/components/headers/X-Concurrent-Threads'
175
+ X-Concurrent-Threads-Active:
176
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
163
177
  '408':
164
178
  description: Request Timeout
165
179
  content:
@@ -174,6 +188,13 @@ paths:
174
188
  status: 408
175
189
  error: Request Timeout
176
190
  message: Timed out while connecting to the remote URL.
191
+ headers:
192
+ X-AF-Credits-Cost:
193
+ $ref: '#/components/headers/X-AF-Credits-Cost'
194
+ X-Concurrent-Threads:
195
+ $ref: '#/components/headers/X-Concurrent-Threads'
196
+ X-Concurrent-Threads-Active:
197
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
177
198
  '429':
178
199
  description: Rate Limit Exceeded
179
200
  content:
@@ -188,6 +209,13 @@ paths:
188
209
  status: 429
189
210
  error: Too Many Requests
190
211
  message: API rate limit exceeded.
212
+ headers:
213
+ X-AF-Credits-Cost:
214
+ $ref: '#/components/headers/X-AF-Credits-Cost'
215
+ X-Concurrent-Threads:
216
+ $ref: '#/components/headers/X-Concurrent-Threads'
217
+ X-Concurrent-Threads-Active:
218
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
191
219
  operationId: checkEmail
192
220
  components:
193
221
  securitySchemes:
@@ -446,6 +474,19 @@ components:
446
474
  type: string
447
475
  format: date-time
448
476
  description: Timestamp when the error occurred (ISO 8601).
477
+ headers:
478
+ X-AF-Credits-Cost:
479
+ description: Specifies the number of credits consumed by the current request.
480
+ schema:
481
+ type: integer
482
+ X-Concurrent-Threads:
483
+ description: Specifies the maximum number of concurrent requests allowed.
484
+ schema:
485
+ type: integer
486
+ X-Concurrent-Threads-Active:
487
+ description: Indicates the number of active concurrent requests being processed.
488
+ schema:
489
+ type: integer
449
490
  security:
450
491
  - ApiKeyAuthHeader: []
451
492
  - ApiKeyAuthQuery: []
@@ -86,6 +86,9 @@ paths:
86
86
  newspapers: 0.07
87
87
  periodicals: 0.07
88
88
  broadcasting: 0
89
+ headers:
90
+ X-AF-Credits-Cost:
91
+ $ref: '#/components/headers/X-AF-Credits-Cost'
89
92
  '400':
90
93
  description: Bad Request — Missing or malformed request body
91
94
  content:
@@ -101,6 +104,9 @@ paths:
101
104
  path: /v1.0/vat/rates/country
102
105
  status: 400
103
106
  timestamp: '2026-07-27T11:46:29.315Z'
107
+ headers:
108
+ X-AF-Credits-Cost:
109
+ $ref: '#/components/headers/X-AF-Credits-Cost'
104
110
  '413':
105
111
  description: Payload Too Large — Request body exceeds the size limit
106
112
  content:
@@ -116,6 +122,9 @@ paths:
116
122
  path: /v1.0/vat/rates/country
117
123
  status: 413
118
124
  timestamp: '2026-07-27T11:46:29.925Z'
125
+ headers:
126
+ X-AF-Credits-Cost:
127
+ $ref: '#/components/headers/X-AF-Credits-Cost'
119
128
  components:
120
129
  securitySchemes:
121
130
  ApiKeyAuthHeader:
@@ -245,6 +254,11 @@ components:
245
254
  type: string
246
255
  format: date-time
247
256
  description: Timestamp when the error occurred (ISO 8601).
257
+ headers:
258
+ X-AF-Credits-Cost:
259
+ description: Specifies the number of credits consumed by the current request.
260
+ schema:
261
+ type: integer
248
262
  security:
249
263
  - ApiKeyAuthHeader: []
250
264
  - ApiKeyAuthQuery: []
@@ -65,6 +65,9 @@ paths:
65
65
  countryCode: DE
66
66
  - name: United States
67
67
  countryCode: US
68
+ headers:
69
+ X-AF-Credits-Cost:
70
+ $ref: '#/components/headers/X-AF-Credits-Cost'
68
71
  components:
69
72
  securitySchemes:
70
73
  ApiKeyAuthHeader:
@@ -147,6 +150,11 @@ components:
147
150
  countryCode:
148
151
  type: string
149
152
  description: ISO 3166-1 alpha-2 country code.
153
+ headers:
154
+ X-AF-Credits-Cost:
155
+ description: Specifies the number of credits consumed by the current request.
156
+ schema:
157
+ type: integer
150
158
  security:
151
159
  - ApiKeyAuthHeader: []
152
160
  - ApiKeyAuthQuery: []
@@ -111,6 +111,9 @@ paths:
111
111
  address: null
112
112
  account: null
113
113
  sepa: null
114
+ headers:
115
+ X-AF-Credits-Cost:
116
+ $ref: '#/components/headers/X-AF-Credits-Cost'
114
117
  '400':
115
118
  description: Bad Request
116
119
  content:
@@ -126,6 +129,9 @@ paths:
126
129
  path: /v1.0/iban/validation
127
130
  status: 400
128
131
  timestamp: '2026-07-27T11:49:29.286Z'
132
+ headers:
133
+ X-AF-Credits-Cost:
134
+ $ref: '#/components/headers/X-AF-Credits-Cost'
129
135
  operationId: validateIban
130
136
  components:
131
137
  securitySchemes:
@@ -265,6 +271,11 @@ components:
265
271
  format: date-time
266
272
  description: Timestamp when the error occurred (ISO 8601).
267
273
  description: Standard error envelope returned by the API on failed requests.
274
+ headers:
275
+ X-AF-Credits-Cost:
276
+ description: Specifies the number of credits consumed by the current request.
277
+ schema:
278
+ type: integer
268
279
  security:
269
280
  - ApiKeyAuthHeader: []
270
281
  - ApiKeyAuthQuery: []
@@ -87,6 +87,9 @@ paths:
87
87
  noMatch:
88
88
  summary: Unmatched country/bank/city — empty array, not an error
89
89
  value: []
90
+ headers:
91
+ X-AF-Credits-Cost:
92
+ $ref: '#/components/headers/X-AF-Credits-Cost'
90
93
  '400':
91
94
  description: Bad Request — Parameters supplied out of order
92
95
  content:
@@ -98,6 +101,9 @@ paths:
98
101
  summary: bank supplied without country
99
102
  value:
100
103
  message: 'Invalid query parameters. Provide parameters in sequence: country → bank → city'
104
+ headers:
105
+ X-AF-Credits-Cost:
106
+ $ref: '#/components/headers/X-AF-Credits-Cost'
101
107
  components:
102
108
  securitySchemes:
103
109
  ApiKeyAuthHeader:
@@ -141,6 +147,11 @@ components:
141
147
  type: string
142
148
  format: date-time
143
149
  description: Timestamp when the error occurred (ISO 8601).
150
+ headers:
151
+ X-AF-Credits-Cost:
152
+ description: Specifies the number of credits consumed by the current request.
153
+ schema:
154
+ type: integer
144
155
  security:
145
156
  - ApiKeyAuthHeader: []
146
157
  - ApiKeyAuthQuery: []
@@ -52,6 +52,9 @@ paths:
52
52
  bankName: NATIONAL WESTMINSTER BANK PLC
53
53
  city: LONDON
54
54
  country: United Kingdom
55
+ headers:
56
+ X-AF-Credits-Cost:
57
+ $ref: '#/components/headers/X-AF-Credits-Cost'
55
58
  '400':
56
59
  description: Bad Request
57
60
  content:
@@ -71,6 +74,9 @@ paths:
71
74
  summary: swiftCode is not 8 or 11 characters
72
75
  value:
73
76
  message: 'Bad request: SWIFT code input must be either 8 characters or 11 characters'
77
+ headers:
78
+ X-AF-Credits-Cost:
79
+ $ref: '#/components/headers/X-AF-Credits-Cost'
74
80
  '404':
75
81
  description: Not Found
76
82
  content:
@@ -82,6 +88,9 @@ paths:
82
88
  summary: SWIFT code not found
83
89
  value:
84
90
  message: No bank found with the provided SWIFT code
91
+ headers:
92
+ X-AF-Credits-Cost:
93
+ $ref: '#/components/headers/X-AF-Credits-Cost'
85
94
  operationId: lookupSwiftCode
86
95
  components:
87
96
  securitySchemes:
@@ -151,6 +160,11 @@ components:
151
160
  format: date-time
152
161
  description: Timestamp when the error occurred (ISO 8601).
153
162
  description: Standard error envelope returned by the API on failed requests.
163
+ headers:
164
+ X-AF-Credits-Cost:
165
+ description: Specifies the number of credits consumed by the current request.
166
+ schema:
167
+ type: integer
154
168
  security:
155
169
  - ApiKeyAuthHeader: []
156
170
  - ApiKeyAuthQuery: []
@@ -75,6 +75,9 @@ paths:
75
75
  company:
76
76
  company_name: EVENTURED LTD
77
77
  company_address: SUITE 10, BEAUFORT COURT, ADMIRALS WAY, LONDON, E14 9XL, GB
78
+ headers:
79
+ X-AF-Credits-Cost:
80
+ $ref: '#/components/headers/X-AF-Credits-Cost'
78
81
  '400':
79
82
  description: Bad Request
80
83
  content:
@@ -94,6 +97,9 @@ paths:
94
97
  summary: Unsupported VAT country code
95
98
  value:
96
99
  message: Unsupported VAT country code. Supported prefixes are UK/GB and EU VAT country codes.
100
+ headers:
101
+ X-AF-Credits-Cost:
102
+ $ref: '#/components/headers/X-AF-Credits-Cost'
97
103
  '404':
98
104
  description: Not Found
99
105
  content:
@@ -105,6 +111,9 @@ paths:
105
111
  summary: VAT number not found
106
112
  value:
107
113
  message: targetVrn does not match a registered company
114
+ headers:
115
+ X-AF-Credits-Cost:
116
+ $ref: '#/components/headers/X-AF-Credits-Cost'
108
117
  operationId: validateVatNumber
109
118
  components:
110
119
  securitySchemes:
@@ -200,6 +209,11 @@ components:
200
209
  format: date-time
201
210
  description: Timestamp when the error occurred (ISO 8601).
202
211
  description: Standard error envelope returned by the API on failed requests.
212
+ headers:
213
+ X-AF-Credits-Cost:
214
+ description: Specifies the number of credits consumed by the current request.
215
+ schema:
216
+ type: integer
203
217
  security:
204
218
  - ApiKeyAuthHeader: []
205
219
  - ApiKeyAuthQuery: []
@@ -66,6 +66,9 @@ paths:
66
66
  type: vat
67
67
  currency: ''
68
68
  standard_rate: 0.0825
69
+ headers:
70
+ X-AF-Credits-Cost:
71
+ $ref: '#/components/headers/X-AF-Credits-Cost'
69
72
  '400':
70
73
  description: Bad Request
71
74
  content:
@@ -77,6 +80,9 @@ paths:
77
80
  summary: Invalid IP address format
78
81
  value:
79
82
  message: Invalid IP address format. Please provide a valid IPv4 or IPv6 address.
83
+ headers:
84
+ X-AF-Credits-Cost:
85
+ $ref: '#/components/headers/X-AF-Credits-Cost'
80
86
  '404':
81
87
  description: Not Found
82
88
  content:
@@ -88,6 +94,9 @@ paths:
88
94
  summary: VAT data not found for IP
89
95
  value:
90
96
  message: No VAT data found. Please provide a valid ipAddress.
97
+ headers:
98
+ X-AF-Credits-Cost:
99
+ $ref: '#/components/headers/X-AF-Credits-Cost'
91
100
  components:
92
101
  securitySchemes:
93
102
  ApiKeyAuthHeader:
@@ -195,6 +204,11 @@ components:
195
204
  format: date-time
196
205
  description: Timestamp when the error occurred (ISO 8601).
197
206
  description: Standard error envelope returned by the API on failed requests.
207
+ headers:
208
+ X-AF-Credits-Cost:
209
+ description: Specifies the number of credits consumed by the current request.
210
+ schema:
211
+ type: integer
198
212
  security:
199
213
  - ApiKeyAuthHeader: []
200
214
  - ApiKeyAuthQuery: []