@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
@@ -71,6 +71,9 @@ paths:
71
71
  endRate: 2039.83
72
72
  change: -23.8
73
73
  changePercent: -1.15
74
+ headers:
75
+ X-AF-Credits-Cost:
76
+ $ref: '#/components/headers/X-AF-Credits-Cost'
74
77
  '400':
75
78
  description: Bad Request — Missing parameters or invalid dates
76
79
  content:
@@ -110,6 +113,9 @@ paths:
110
113
  message: Start date cannot be after end date
111
114
  schema:
112
115
  $ref: '#/components/schemas/ErrorResponse'
116
+ headers:
117
+ X-AF-Credits-Cost:
118
+ $ref: '#/components/headers/X-AF-Credits-Cost'
113
119
  '404':
114
120
  description: Not found - Symbol or data not available
115
121
  content:
@@ -133,6 +139,9 @@ paths:
133
139
  code: 404
134
140
  error: DATA_NOT_FOUND
135
141
  message: No data found for the given date range
142
+ headers:
143
+ X-AF-Credits-Cost:
144
+ $ref: '#/components/headers/X-AF-Credits-Cost'
136
145
  components:
137
146
  securitySchemes:
138
147
  ApiKeyAuthHeader:
@@ -220,6 +229,11 @@ components:
220
229
  type: string
221
230
  format: date-time
222
231
  description: Timestamp when the error occurred (ISO 8601).
232
+ headers:
233
+ X-AF-Credits-Cost:
234
+ description: Specifies the number of credits consumed by the current request.
235
+ schema:
236
+ type: integer
223
237
  security:
224
238
  - ApiKeyAuthHeader: []
225
239
  - ApiKeyAuthQuery: []
@@ -84,6 +84,9 @@ paths:
84
84
  XAU:
85
85
  unit: T.oz
86
86
  quote: EUR
87
+ headers:
88
+ X-AF-Credits-Cost:
89
+ $ref: '#/components/headers/X-AF-Credits-Cost'
87
90
  '400':
88
91
  description: Bad Request — Missing or invalid query parameters
89
92
  content:
@@ -107,6 +110,9 @@ paths:
107
110
  path: /v1.0/commodity/rates/latest
108
111
  status: 400
109
112
  timestamp: '2026-07-27T11:36:35.755Z'
113
+ headers:
114
+ X-AF-Credits-Cost:
115
+ $ref: '#/components/headers/X-AF-Credits-Cost'
110
116
  '404':
111
117
  description: Not found - Symbol or quote currency not available
112
118
  content:
@@ -130,6 +136,9 @@ paths:
130
136
  code: 404
131
137
  error: QUOTE_NOT_FOUND
132
138
  message: The quote currency is invalid, please visit the documentation for a list of valid quote currencies
139
+ headers:
140
+ X-AF-Credits-Cost:
141
+ $ref: '#/components/headers/X-AF-Credits-Cost'
133
142
  components:
134
143
  securitySchemes:
135
144
  ApiKeyAuthHeader:
@@ -231,6 +240,11 @@ components:
231
240
  message:
232
241
  type: string
233
242
  description: Human-readable error message describing the failure.
243
+ headers:
244
+ X-AF-Credits-Cost:
245
+ description: Specifies the number of credits consumed by the current request.
246
+ schema:
247
+ type: integer
234
248
  security:
235
249
  - ApiKeyAuthHeader: []
236
250
  - ApiKeyAuthQuery: []
@@ -65,6 +65,9 @@ paths:
65
65
  unit:
66
66
  symbol: MMBtu
67
67
  name: Million British Thermal Units
68
+ headers:
69
+ X-AF-Credits-Cost:
70
+ $ref: '#/components/headers/X-AF-Credits-Cost'
68
71
  components:
69
72
  securitySchemes:
70
73
  ApiKeyAuthHeader:
@@ -154,6 +157,11 @@ components:
154
157
  name:
155
158
  type: string
156
159
  description: Full name of the unit of measurement (e.g., Troy Ounce).
160
+ headers:
161
+ X-AF-Credits-Cost:
162
+ description: Specifies the number of credits consumed by the current request.
163
+ schema:
164
+ type: integer
157
165
  security:
158
166
  - ApiKeyAuthHeader: []
159
167
  - ApiKeyAuthQuery: []
@@ -79,6 +79,9 @@ paths:
79
79
  high: 2674.68
80
80
  low: 2668.58
81
81
  close: 2671.8
82
+ headers:
83
+ X-AF-Credits-Cost:
84
+ $ref: '#/components/headers/X-AF-Credits-Cost'
82
85
  '400':
83
86
  description: Bad Request — Missing parameters, invalid dates, or date range exceeded
84
87
  content:
@@ -118,6 +121,9 @@ paths:
118
121
  message: Date range exceeds the allowed limit.
119
122
  schema:
120
123
  $ref: '#/components/schemas/ErrorResponse'
124
+ headers:
125
+ X-AF-Credits-Cost:
126
+ $ref: '#/components/headers/X-AF-Credits-Cost'
121
127
  '404':
122
128
  description: Not found - Symbol or data not available
123
129
  content:
@@ -141,6 +147,9 @@ paths:
141
147
  code: 404
142
148
  error: DATA_NOT_FOUND
143
149
  message: No data found for the specified date range
150
+ headers:
151
+ X-AF-Credits-Cost:
152
+ $ref: '#/components/headers/X-AF-Credits-Cost'
144
153
  components:
145
154
  securitySchemes:
146
155
  ApiKeyAuthHeader:
@@ -233,6 +242,11 @@ components:
233
242
  type: string
234
243
  format: date-time
235
244
  description: Timestamp when the error occurred (ISO 8601).
245
+ headers:
246
+ X-AF-Credits-Cost:
247
+ description: Specifies the number of credits consumed by the current request.
248
+ schema:
249
+ type: integer
236
250
  security:
237
251
  - ApiKeyAuthHeader: []
238
252
  - ApiKeyAuthQuery: []
@@ -66,6 +66,9 @@ paths:
66
66
  high: 2697.85
67
67
  low: 2663.61
68
68
  close: 2689.44
69
+ headers:
70
+ X-AF-Credits-Cost:
71
+ $ref: '#/components/headers/X-AF-Credits-Cost'
69
72
  '400':
70
73
  description: Bad request - Invalid date format
71
74
  content:
@@ -89,6 +92,9 @@ paths:
89
92
  error: VALIDATION_ERROR
90
93
  message: 'Invalid Date: The provided date does not exist.'
91
94
  path: /v1.0/commodity/rates/historical
95
+ headers:
96
+ X-AF-Credits-Cost:
97
+ $ref: '#/components/headers/X-AF-Credits-Cost'
92
98
  '404':
93
99
  description: Not found - Symbol or rate not available
94
100
  content:
@@ -112,6 +118,9 @@ paths:
112
118
  error: RATE_NOT_FOUND
113
119
  message: no rates found for the specified date
114
120
  path: /v1.0/commodity/rates/historical
121
+ headers:
122
+ X-AF-Credits-Cost:
123
+ $ref: '#/components/headers/X-AF-Credits-Cost'
115
124
  components:
116
125
  securitySchemes:
117
126
  ApiKeyAuthHeader:
@@ -203,6 +212,11 @@ components:
203
212
  type: string
204
213
  description: API endpoint path that produced the error.
205
214
  description: Standard error envelope returned by the API on failed requests.
215
+ headers:
216
+ X-AF-Credits-Cost:
217
+ description: Specifies the number of credits consumed by the current request.
218
+ schema:
219
+ type: integer
206
220
  security:
207
221
  - ApiKeyAuthHeader: []
208
222
  - ApiKeyAuthQuery: []
@@ -77,6 +77,9 @@ paths:
77
77
  rate: '0.87800'
78
78
  givenAmount: '100.0'
79
79
  convertedAmount: '87.800'
80
+ headers:
81
+ X-AF-Credits-Cost:
82
+ $ref: '#/components/headers/X-AF-Credits-Cost'
80
83
  '400':
81
84
  description: Bad request - Invalid amount or updates parameter
82
85
  content:
@@ -108,6 +111,9 @@ paths:
108
111
  error: Invalid Param Exception
109
112
  message: Please provide valid updates parameter (1d,1h,10m,1m)
110
113
  path: /v2.0/convert/latest
114
+ headers:
115
+ X-AF-Credits-Cost:
116
+ $ref: '#/components/headers/X-AF-Credits-Cost'
111
117
  '404':
112
118
  description: Not found - Currency not available
113
119
  content:
@@ -123,6 +129,9 @@ paths:
123
129
  error: Not Found Exception
124
130
  message: Rates of provided currency ZZZ are not available in our database!
125
131
  path: /v2.0/convert/latest
132
+ headers:
133
+ X-AF-Credits-Cost:
134
+ $ref: '#/components/headers/X-AF-Credits-Cost'
126
135
  components:
127
136
  securitySchemes:
128
137
  ApiKeyAuthHeader:
@@ -188,6 +197,11 @@ components:
188
197
  path:
189
198
  type: string
190
199
  description: API endpoint path (gateway errors) or internal service path (currency-service errors) that produced the error.
200
+ headers:
201
+ X-AF-Credits-Cost:
202
+ description: Specifies the number of credits consumed by the current request.
203
+ schema:
204
+ type: integer
191
205
  security:
192
206
  - ApiKeyAuthHeader: []
193
207
  - ApiKeyAuthQuery: []
@@ -79,6 +79,9 @@ paths:
79
79
  endRate: '278.650'
80
80
  change: '-0.25'
81
81
  percentChange: '-0.09'
82
+ headers:
83
+ X-AF-Credits-Cost:
84
+ $ref: '#/components/headers/X-AF-Credits-Cost'
82
85
  '400':
83
86
  description: Bad request - Invalid dates
84
87
  content:
@@ -110,6 +113,9 @@ paths:
110
113
  error: Invalid Param Exception
111
114
  message: Provided Dates are in Invalid Format. Dates must be in a valid format YYYY-MM-DD!
112
115
  path: /v2.0/fluctuation
116
+ headers:
117
+ X-AF-Credits-Cost:
118
+ $ref: '#/components/headers/X-AF-Credits-Cost'
113
119
  '404':
114
120
  description: Not found - No data for interval
115
121
  content:
@@ -125,6 +131,9 @@ paths:
125
131
  error: Not Found Exception
126
132
  message: Rates of provided base and symbols are not found for given intervals.
127
133
  path: /v2.0/fluctuation
134
+ headers:
135
+ X-AF-Credits-Cost:
136
+ $ref: '#/components/headers/X-AF-Credits-Cost'
128
137
  components:
129
138
  securitySchemes:
130
139
  ApiKeyAuthHeader:
@@ -206,6 +215,11 @@ components:
206
215
  path:
207
216
  type: string
208
217
  description: API endpoint path (gateway errors) or internal service path (currency-service errors) that produced the error.
218
+ headers:
219
+ X-AF-Credits-Cost:
220
+ description: Specifies the number of credits consumed by the current request.
221
+ schema:
222
+ type: integer
209
223
  security:
210
224
  - ApiKeyAuthHeader: []
211
225
  - ApiKeyAuthQuery: []
@@ -44,6 +44,9 @@ paths:
44
44
  FJD: 1989-08-18 to 2026-07-27
45
45
  SCR: 1998-07-31 to 2026-07-27
46
46
  STPT: 2025-02-27 to 2025-05-28
47
+ headers:
48
+ X-AF-Credits-Cost:
49
+ $ref: '#/components/headers/X-AF-Credits-Cost'
47
50
  '406':
48
51
  description: Unsupported Media Type — format is not json or xml
49
52
  content:
@@ -59,6 +62,9 @@ paths:
59
62
  path: /v1.0/currency/historical/data/limits
60
63
  status: 406
61
64
  timestamp: '2026-07-27T12:14:01.189Z'
65
+ headers:
66
+ X-AF-Credits-Cost:
67
+ $ref: '#/components/headers/X-AF-Credits-Cost'
62
68
  components:
63
69
  securitySchemes:
64
70
  ApiKeyAuthHeader:
@@ -107,6 +113,11 @@ components:
107
113
  type: string
108
114
  format: date-time
109
115
  description: Timestamp when the error occurred (ISO 8601).
116
+ headers:
117
+ X-AF-Credits-Cost:
118
+ description: Specifies the number of credits consumed by the current request.
119
+ schema:
120
+ type: integer
110
121
  security:
111
122
  - ApiKeyAuthHeader: []
112
123
  - ApiKeyAuthQuery: []
@@ -70,6 +70,9 @@ paths:
70
70
  rates:
71
71
  EUR: '0.878156'
72
72
  PKR: '277.863'
73
+ headers:
74
+ X-AF-Credits-Cost:
75
+ $ref: '#/components/headers/X-AF-Credits-Cost'
73
76
  '400':
74
77
  description: Bad request - Invalid parameters
75
78
  content:
@@ -85,6 +88,9 @@ paths:
85
88
  error: Invalid Param Exception
86
89
  message: Please provide valid updates parameter (1d,1h,10m,1m)
87
90
  path: /v2.0/rates/latest
91
+ headers:
92
+ X-AF-Credits-Cost:
93
+ $ref: '#/components/headers/X-AF-Credits-Cost'
88
94
  '404':
89
95
  description: Not found - Currency or symbol not available
90
96
  content:
@@ -108,6 +114,9 @@ paths:
108
114
  error: Not Found Exception
109
115
  message: Rates of provided Symbols are not available in our database!
110
116
  path: /v2.0/rates/latest
117
+ headers:
118
+ X-AF-Credits-Cost:
119
+ $ref: '#/components/headers/X-AF-Credits-Cost'
111
120
  components:
112
121
  securitySchemes:
113
122
  ApiKeyAuthHeader:
@@ -168,6 +177,11 @@ components:
168
177
  type: string
169
178
  description: API endpoint path that produced the error.
170
179
  description: Standard error envelope returned by the API on failed requests.
180
+ headers:
181
+ X-AF-Credits-Cost:
182
+ description: Specifies the number of credits consumed by the current request.
183
+ schema:
184
+ type: integer
171
185
  security:
172
186
  - ApiKeyAuthHeader: []
173
187
  - ApiKeyAuthQuery: []
@@ -68,6 +68,9 @@ paths:
68
68
  availableFrom: '2020-01-01'
69
69
  availableUntil: '2026-06-18'
70
70
  icon: https://currencyfreaks.com/photos/flags/xau.png
71
+ headers:
72
+ X-AF-Credits-Cost:
73
+ $ref: '#/components/headers/X-AF-Credits-Cost'
71
74
  '406':
72
75
  description: Unsupported Media Type — format is not json or xml
73
76
  content:
@@ -83,6 +86,9 @@ paths:
83
86
  path: /v1.0/currency/supported
84
87
  status: 406
85
88
  timestamp: '2026-07-27T12:12:35.587Z'
89
+ headers:
90
+ X-AF-Credits-Cost:
91
+ $ref: '#/components/headers/X-AF-Credits-Cost'
86
92
  components:
87
93
  securitySchemes:
88
94
  ApiKeyAuthHeader:
@@ -171,6 +177,11 @@ components:
171
177
  type: string
172
178
  format: date-time
173
179
  description: Timestamp when the error occurred (ISO 8601).
180
+ headers:
181
+ X-AF-Credits-Cost:
182
+ description: Specifies the number of credits consumed by the current request.
183
+ schema:
184
+ type: integer
174
185
  security:
175
186
  - ApiKeyAuthHeader: []
176
187
  - ApiKeyAuthQuery: []
@@ -47,6 +47,9 @@ paths:
47
47
  PKR: Pakistani Rupee
48
48
  BTC: Bitcoin
49
49
  XAU: Gold (troy ounce)
50
+ headers:
51
+ X-AF-Credits-Cost:
52
+ $ref: '#/components/headers/X-AF-Credits-Cost'
50
53
  '406':
51
54
  description: Unsupported Media Type — format is not json or xml
52
55
  content:
@@ -62,6 +65,9 @@ paths:
62
65
  path: /v1.0/currency/symbols
63
66
  status: 406
64
67
  timestamp: '2026-07-27T12:13:24.369Z'
68
+ headers:
69
+ X-AF-Credits-Cost:
70
+ $ref: '#/components/headers/X-AF-Credits-Cost'
65
71
  components:
66
72
  securitySchemes:
67
73
  ApiKeyAuthHeader:
@@ -110,6 +116,11 @@ components:
110
116
  type: string
111
117
  format: date-time
112
118
  description: Timestamp when the error occurred (ISO 8601).
119
+ headers:
120
+ X-AF-Credits-Cost:
121
+ description: Specifies the number of credits consumed by the current request.
122
+ schema:
123
+ type: integer
113
124
  security:
114
125
  - ApiKeyAuthHeader: []
115
126
  - ApiKeyAuthQuery: []
@@ -97,6 +97,9 @@ paths:
97
97
  rates:
98
98
  EUR: '0.967'
99
99
  PKR: '278.4'
100
+ headers:
101
+ X-AF-Credits-Cost:
102
+ $ref: '#/components/headers/X-AF-Credits-Cost'
100
103
  '400':
101
104
  description: Bad request - Invalid dates or range exceeded
102
105
  content:
@@ -136,6 +139,9 @@ paths:
136
139
  error: Invalid Param Exception
137
140
  message: Provided Dates are in Invalid Format. Dates must be in a valid format YYYY-MM-DD!
138
141
  path: /v2.0/timeseries
142
+ headers:
143
+ X-AF-Credits-Cost:
144
+ $ref: '#/components/headers/X-AF-Credits-Cost'
139
145
  '404':
140
146
  description: Not found - No data for interval
141
147
  content:
@@ -151,6 +157,9 @@ paths:
151
157
  error: Not Found Exception
152
158
  message: Rates of provided base and symbols are not found for given intervals.
153
159
  path: /v2.0/timeseries
160
+ headers:
161
+ X-AF-Credits-Cost:
162
+ $ref: '#/components/headers/X-AF-Credits-Cost'
154
163
  components:
155
164
  securitySchemes:
156
165
  ApiKeyAuthHeader:
@@ -227,6 +236,11 @@ components:
227
236
  path:
228
237
  type: string
229
238
  description: API endpoint path (gateway errors) or internal service path (currency-service errors) that produced the error.
239
+ headers:
240
+ X-AF-Credits-Cost:
241
+ description: Specifies the number of credits consumed by the current request.
242
+ schema:
243
+ type: integer
230
244
  security:
231
245
  - ApiKeyAuthHeader: []
232
246
  - ApiKeyAuthQuery: []
@@ -78,6 +78,9 @@ paths:
78
78
  ipAddress: 182.186.18.91
79
79
  givenAmount: '100.0'
80
80
  convertedAmount: '27786.300'
81
+ headers:
82
+ X-AF-Credits-Cost:
83
+ $ref: '#/components/headers/X-AF-Credits-Cost'
81
84
  '400':
82
85
  description: Bad request - Invalid IP, amount, or updates
83
86
  content:
@@ -117,6 +120,9 @@ paths:
117
120
  error: Invalid Param Exception
118
121
  message: Please provide valid updates parameter (1d,1h,10m,1m)
119
122
  path: /v2.0/iptocurrency
123
+ headers:
124
+ X-AF-Credits-Cost:
125
+ $ref: '#/components/headers/X-AF-Credits-Cost'
120
126
  '404':
121
127
  description: Not found - IP geolocation or currency not available
122
128
  content:
@@ -140,6 +146,9 @@ paths:
140
146
  error: Not Found Exception
141
147
  message: Rates of provided currency ZZZ are not available in our database!
142
148
  path: /v2.0/iptocurrency
149
+ headers:
150
+ X-AF-Credits-Cost:
151
+ $ref: '#/components/headers/X-AF-Credits-Cost'
143
152
  components:
144
153
  securitySchemes:
145
154
  ApiKeyAuthHeader:
@@ -209,6 +218,11 @@ components:
209
218
  path:
210
219
  type: string
211
220
  description: API endpoint path (gateway errors) or internal service path (currency-service errors) that produced the error.
221
+ headers:
222
+ X-AF-Credits-Cost:
223
+ description: Specifies the number of credits consumed by the current request.
224
+ schema:
225
+ type: integer
212
226
  security:
213
227
  - ApiKeyAuthHeader: []
214
228
  - ApiKeyAuthQuery: []
@@ -71,6 +71,9 @@ paths:
71
71
  rate: '0.97620'
72
72
  givenAmount: '100.0'
73
73
  convertedAmount: '97.620'
74
+ headers:
75
+ X-AF-Credits-Cost:
76
+ $ref: '#/components/headers/X-AF-Credits-Cost'
74
77
  '400':
75
78
  description: Bad request - Invalid amount or date format
76
79
  content:
@@ -102,6 +105,9 @@ paths:
102
105
  error: Invalid Param Exception
103
106
  message: Provided Date 10-01-2025 is in invalid format. It should be like YYYY-MM-DD!
104
107
  path: /v2.0/convert/historical
108
+ headers:
109
+ X-AF-Credits-Cost:
110
+ $ref: '#/components/headers/X-AF-Credits-Cost'
105
111
  '404':
106
112
  description: Not found - Currency or date not available
107
113
  content:
@@ -125,6 +131,9 @@ paths:
125
131
  error: Not Found Exception
126
132
  message: Rates of provided currency ZZZ are not available in our database!
127
133
  path: /v2.0/convert/historical
134
+ headers:
135
+ X-AF-Credits-Cost:
136
+ $ref: '#/components/headers/X-AF-Credits-Cost'
128
137
  components:
129
138
  securitySchemes:
130
139
  ApiKeyAuthHeader:
@@ -190,6 +199,11 @@ components:
190
199
  path:
191
200
  type: string
192
201
  description: API endpoint path (gateway errors) or internal service path (currency-service errors) that produced the error.
202
+ headers:
203
+ X-AF-Credits-Cost:
204
+ description: Specifies the number of credits consumed by the current request.
205
+ schema:
206
+ type: integer
193
207
  security:
194
208
  - ApiKeyAuthHeader: []
195
209
  - ApiKeyAuthQuery: []
@@ -64,6 +64,9 @@ paths:
64
64
  rates:
65
65
  EUR: '0.9762'
66
66
  PKR: '278.65'
67
+ headers:
68
+ X-AF-Credits-Cost:
69
+ $ref: '#/components/headers/X-AF-Credits-Cost'
67
70
  '400':
68
71
  description: Bad Request — Missing or malformed date
69
72
  content:
@@ -87,6 +90,9 @@ paths:
87
90
  error: Invalid Param Exception
88
91
  message: Provided Date 10-01-2025 is in invalid format. It should be like YYYY-MM-DD!
89
92
  path: /v2.0/rates/historical
93
+ headers:
94
+ X-AF-Credits-Cost:
95
+ $ref: '#/components/headers/X-AF-Credits-Cost'
90
96
  '404':
91
97
  description: Not found - Currency, symbol, or date not available
92
98
  content:
@@ -118,6 +124,9 @@ paths:
118
124
  error: Not Found Exception
119
125
  message: Rates of provided Symbols are not available in our database!
120
126
  path: /v2.0/rates/historical
127
+ headers:
128
+ X-AF-Credits-Cost:
129
+ $ref: '#/components/headers/X-AF-Credits-Cost'
121
130
  components:
122
131
  securitySchemes:
123
132
  ApiKeyAuthHeader:
@@ -175,6 +184,11 @@ components:
175
184
  - string
176
185
  - integer
177
186
  description: Timestamp when the error occurred — ISO 8601 string for gateway errors, Unix milliseconds integer for currency-service errors.
187
+ headers:
188
+ X-AF-Credits-Cost:
189
+ description: Specifies the number of credits consumed by the current request.
190
+ schema:
191
+ type: integer
178
192
  security:
179
193
  - ApiKeyAuthHeader: []
180
194
  - ApiKeyAuthQuery: []
@@ -262,6 +262,9 @@ paths:
262
262
  rRsetType: 99
263
263
  strings:
264
264
  - v=spf1 -all
265
+ headers:
266
+ X-AF-Credits-Cost:
267
+ $ref: '#/components/headers/X-AF-Credits-Cost'
265
268
  '400':
266
269
  description: Bad Request — Missing type parameter or malformed request body
267
270
  content:
@@ -285,6 +288,9 @@ paths:
285
288
  path: /v1.0/domain/dns/live
286
289
  status: 400
287
290
  timestamp: '2026-07-23T09:52:49.074Z'
291
+ headers:
292
+ X-AF-Credits-Cost:
293
+ $ref: '#/components/headers/X-AF-Credits-Cost'
288
294
  '413':
289
295
  description: Payload Too Large — Request exceeds the 100-hostname batch limit
290
296
  content:
@@ -300,6 +306,9 @@ paths:
300
306
  path: /v1.0/domain/dns/live
301
307
  status: 413
302
308
  timestamp: '2026-07-23T09:52:49.621Z'
309
+ headers:
310
+ X-AF-Credits-Cost:
311
+ $ref: '#/components/headers/X-AF-Credits-Cost'
303
312
  components:
304
313
  securitySchemes:
305
314
  ApiKeyAuthHeader:
@@ -479,6 +488,11 @@ components:
479
488
  message:
480
489
  type: string
481
490
  description: Error message.
491
+ headers:
492
+ X-AF-Credits-Cost:
493
+ description: Specifies the number of credits consumed by the current request.
494
+ schema:
495
+ type: integer
482
496
  security:
483
497
  - ApiKeyAuthHeader: []
484
498
  - ApiKeyAuthQuery: []
@@ -246,6 +246,9 @@ paths:
246
246
  rawText: "example.com.\t\t128\tIN\tNS\tb.iana-servers.net."
247
247
  rRsetType: 2
248
248
  singleName: b.iana-servers.net.
249
+ headers:
250
+ X-AF-Credits-Cost:
251
+ $ref: '#/components/headers/X-AF-Credits-Cost'
249
252
  '400':
250
253
  description: Bad Request — Invalid DNS type or malformed hostname
251
254
  content:
@@ -269,6 +272,9 @@ paths:
269
272
  error: Invalid Param Exception
270
273
  message: 'Please pass domain param correct value[For Technical Support: support@whoisfreaks.com]'
271
274
  path: /v2.0/dns/historical
275
+ headers:
276
+ X-AF-Credits-Cost:
277
+ $ref: '#/components/headers/X-AF-Credits-Cost'
272
278
  '404':
273
279
  description: Not Found — No DNS history records for the hostname
274
280
  content:
@@ -284,6 +290,9 @@ paths:
284
290
  error: Record not Found
285
291
  message: 'No Record Found across: zzsuperrandomnonexistent998877.com'
286
292
  path: /v2.0/dns/historical
293
+ headers:
294
+ X-AF-Credits-Cost:
295
+ $ref: '#/components/headers/X-AF-Credits-Cost'
287
296
  components:
288
297
  securitySchemes:
289
298
  ApiKeyAuthHeader:
@@ -446,6 +455,11 @@ components:
446
455
  description: Verification or policy strings. Present only when dnsType is TXT or SPF.
447
456
  items:
448
457
  type: string
458
+ headers:
459
+ X-AF-Credits-Cost:
460
+ description: Specifies the number of credits consumed by the current request.
461
+ schema:
462
+ type: integer
449
463
  security:
450
464
  - ApiKeyAuthHeader: []
451
465
  - ApiKeyAuthQuery: []