@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
@@ -60,6 +60,9 @@ paths:
60
60
  value:
61
61
  fileName: binarytest.pdf
62
62
  fileId: b0fbf78c-8fe2-49b6-ad3d-63efb4ac8e58
63
+ headers:
64
+ X-AF-Credits-Cost:
65
+ $ref: '#/components/headers/X-AF-Credits-Cost'
63
66
  '400':
64
67
  description: Bad Request — Missing file_name or empty body
65
68
  content:
@@ -83,6 +86,9 @@ paths:
83
86
  message: Invalid parameter value provided for 'dataBufferFlux'.
84
87
  schema:
85
88
  $ref: '#/components/schemas/ErrorResponse'
89
+ headers:
90
+ X-AF-Credits-Cost:
91
+ $ref: '#/components/headers/X-AF-Credits-Cost'
86
92
  '415':
87
93
  description: Unsupported Media Type — File extension not supported
88
94
  content:
@@ -98,6 +104,9 @@ paths:
98
104
  message: The provided file type is not supported. Refer to the documentation for valid file types.
99
105
  schema:
100
106
  $ref: '#/components/schemas/ErrorResponse'
107
+ headers:
108
+ X-AF-Credits-Cost:
109
+ $ref: '#/components/headers/X-AF-Credits-Cost'
101
110
  operationId: uploadResourceBinary
102
111
  components:
103
112
  securitySchemes:
@@ -147,6 +156,11 @@ components:
147
156
  type: string
148
157
  format: date-time
149
158
  description: Timestamp when the error occurred (ISO 8601).
159
+ headers:
160
+ X-AF-Credits-Cost:
161
+ description: Specifies the number of credits consumed by the current request.
162
+ schema:
163
+ type: integer
150
164
  security:
151
165
  - ApiKeyAuthHeader: []
152
166
  - ApiKeyAuthQuery: []
@@ -63,6 +63,9 @@ paths:
63
63
  fileId: 9922d104-25a0-432c-8c26-2be2ba14798a
64
64
  - fileName: test.pdf
65
65
  fileId: 8a6b3332-6fe0-42b0-a808-df7a36926a79
66
+ headers:
67
+ X-AF-Credits-Cost:
68
+ $ref: '#/components/headers/X-AF-Credits-Cost'
66
69
  '400':
67
70
  description: Bad Request — Missing or invalid parameters
68
71
  content:
@@ -78,6 +81,9 @@ paths:
78
81
  status: 400
79
82
  error: Missing or Invalid Parameters
80
83
  message: One or more required parameters are missing or incorrect.
84
+ headers:
85
+ X-AF-Credits-Cost:
86
+ $ref: '#/components/headers/X-AF-Credits-Cost'
81
87
  '415':
82
88
  description: Unsupported Media Type — File type not supported
83
89
  content:
@@ -93,6 +99,9 @@ paths:
93
99
  status: 415
94
100
  error: Unsupported File Type
95
101
  message: The provided file type is not supported. Refer to the documentation for valid file types.
102
+ headers:
103
+ X-AF-Credits-Cost:
104
+ $ref: '#/components/headers/X-AF-Credits-Cost'
96
105
  components:
97
106
  securitySchemes:
98
107
  ApiKeyAuthHeader:
@@ -158,6 +167,11 @@ components:
158
167
  type: string
159
168
  format: date-time
160
169
  description: Timestamp when the error occurred (ISO 8601).
170
+ headers:
171
+ X-AF-Credits-Cost:
172
+ description: Specifies the number of credits consumed by the current request.
173
+ schema:
174
+ type: integer
161
175
  security:
162
176
  - ApiKeyAuthHeader: []
163
177
  - ApiKeyAuthQuery: []
@@ -120,6 +120,9 @@ paths:
120
120
  taskId: 42839406-7e1b-4f64-96bb-d94bb054e8d3
121
121
  inputIds:
122
122
  - 2c682ade-eccc-4ab5-9c06-d16e415cbecb
123
+ headers:
124
+ X-AF-Credits-Cost:
125
+ $ref: '#/components/headers/X-AF-Credits-Cost'
123
126
  '400':
124
127
  description: Bad Request — Missing/invalid parameters, file ID, or password
125
128
  content:
@@ -167,6 +170,9 @@ paths:
167
170
  message: Please provide valid PDF restrictions. Refer to the documentation for valid PDF restrictions.
168
171
  schema:
169
172
  $ref: '#/components/schemas/ErrorResponse'
173
+ headers:
174
+ X-AF-Credits-Cost:
175
+ $ref: '#/components/headers/X-AF-Credits-Cost'
170
176
  '415':
171
177
  description: Unsupported Media Type — File type not supported
172
178
  content:
@@ -182,6 +188,9 @@ paths:
182
188
  status: 415
183
189
  error: Unsupported File Type
184
190
  message: The provided file type is not supported. Refer to the documentation for valid file types.
191
+ headers:
192
+ X-AF-Credits-Cost:
193
+ $ref: '#/components/headers/X-AF-Credits-Cost'
185
194
  operationId: restrictPdf
186
195
  components:
187
196
  securitySchemes:
@@ -241,6 +250,11 @@ components:
241
250
  type: string
242
251
  format: date-time
243
252
  description: Timestamp when the error occurred (ISO 8601).
253
+ headers:
254
+ X-AF-Credits-Cost:
255
+ description: Specifies the number of credits consumed by the current request.
256
+ schema:
257
+ type: integer
244
258
  security:
245
259
  - ApiKeyAuthHeader: []
246
260
  - ApiKeyAuthQuery: []
@@ -114,6 +114,9 @@ paths:
114
114
  taskId: a533a95c-b3fb-49f0-abb1-bef2f3e805ef
115
115
  inputIds:
116
116
  - 62f910b6-69ce-4cbc-8285-eee5f16467be
117
+ headers:
118
+ X-AF-Credits-Cost:
119
+ $ref: '#/components/headers/X-AF-Credits-Cost'
117
120
  '400':
118
121
  description: Bad Request — Invalid file ID
119
122
  content:
@@ -129,6 +132,9 @@ paths:
129
132
  timestamp: '2026-07-27T10:54:00.793Z'
130
133
  schema:
131
134
  $ref: '#/components/schemas/ErrorResponse'
135
+ headers:
136
+ X-AF-Credits-Cost:
137
+ $ref: '#/components/headers/X-AF-Credits-Cost'
132
138
  '415':
133
139
  description: Unsupported Media Type — File type not supported
134
140
  content:
@@ -144,6 +150,9 @@ paths:
144
150
  message: The provided file type is not supported. Refer to the documentation for valid file types.
145
151
  schema:
146
152
  $ref: '#/components/schemas/ErrorResponse'
153
+ headers:
154
+ X-AF-Credits-Cost:
155
+ $ref: '#/components/headers/X-AF-Credits-Cost'
147
156
  operationId: splitPdf
148
157
  components:
149
158
  securitySchemes:
@@ -203,6 +212,11 @@ components:
203
212
  type: string
204
213
  format: date-time
205
214
  description: Timestamp when the error occurred (ISO 8601).
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: []
@@ -67,6 +67,9 @@ paths:
67
67
  error: Invalid Page Range
68
68
  message: One or more specified page numbers exceed the total number of pages in the PDF document.
69
69
  expiresAt: '2026-08-03 10:52:12'
70
+ headers:
71
+ X-AF-Credits-Cost:
72
+ $ref: '#/components/headers/X-AF-Credits-Cost'
70
73
  '400':
71
74
  description: Bad Request — Missing required task_id parameter
72
75
  content:
@@ -82,6 +85,9 @@ paths:
82
85
  timestamp: '2026-07-27T10:49:06.412Z'
83
86
  schema:
84
87
  $ref: '#/components/schemas/ErrorResponse'
88
+ headers:
89
+ X-AF-Credits-Cost:
90
+ $ref: '#/components/headers/X-AF-Credits-Cost'
85
91
  '404':
86
92
  description: Task ID Not Found
87
93
  content:
@@ -97,6 +103,9 @@ paths:
97
103
  message: Please provide a valid task ID.
98
104
  schema:
99
105
  $ref: '#/components/schemas/ErrorResponse'
106
+ headers:
107
+ X-AF-Credits-Cost:
108
+ $ref: '#/components/headers/X-AF-Credits-Cost'
100
109
  operationId: getTaskStatus
101
110
  components:
102
111
  securitySchemes:
@@ -182,6 +191,11 @@ components:
182
191
  type: string
183
192
  format: date-time
184
193
  description: Timestamp when the error occurred (ISO 8601).
194
+ headers:
195
+ X-AF-Credits-Cost:
196
+ description: Specifies the number of credits consumed by the current request.
197
+ schema:
198
+ type: integer
185
199
  security:
186
200
  - ApiKeyAuthHeader: []
187
201
  - ApiKeyAuthQuery: []
@@ -116,6 +116,9 @@ paths:
116
116
  taskId: b48e5ed0-e5ce-41bd-953c-6c590ded4b20
117
117
  inputIds:
118
118
  - 6d994947-3909-46cf-91fe-24316c457e2a
119
+ headers:
120
+ X-AF-Credits-Cost:
121
+ $ref: '#/components/headers/X-AF-Credits-Cost'
119
122
  '400':
120
123
  description: Bad Request — Missing/invalid parameters or file ID
121
124
  content:
@@ -163,6 +166,9 @@ paths:
163
166
  message: Please provide a valid image resolution(dpi). Refer to the documentation for valid resolution values.
164
167
  schema:
165
168
  $ref: '#/components/schemas/ErrorResponse'
169
+ headers:
170
+ X-AF-Credits-Cost:
171
+ $ref: '#/components/headers/X-AF-Credits-Cost'
166
172
  operationId: pdfToImage
167
173
  /pdf/jpg:
168
174
  post:
@@ -272,6 +278,9 @@ paths:
272
278
  taskId: 04a06cd5-158d-4191-a45b-6f58249c599d
273
279
  inputIds:
274
280
  - 7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f
281
+ headers:
282
+ X-AF-Credits-Cost:
283
+ $ref: '#/components/headers/X-AF-Credits-Cost'
275
284
  '400':
276
285
  description: Bad Request — Missing/invalid parameters or file ID
277
286
  content:
@@ -327,6 +336,9 @@ paths:
327
336
  message: Please provide a valid image resolution(dpi). Refer to the documentation for valid resolution values.
328
337
  schema:
329
338
  $ref: '#/components/schemas/ErrorResponse'
339
+ headers:
340
+ X-AF-Credits-Cost:
341
+ $ref: '#/components/headers/X-AF-Credits-Cost'
330
342
  /pdf/tif:
331
343
  post:
332
344
  tags:
@@ -431,6 +443,9 @@ paths:
431
443
  taskId: 04a06cd5-158d-4191-a45b-6f58249c599d
432
444
  inputIds:
433
445
  - 7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f
446
+ headers:
447
+ X-AF-Credits-Cost:
448
+ $ref: '#/components/headers/X-AF-Credits-Cost'
434
449
  '400':
435
450
  description: Bad Request — Missing/invalid parameters or file ID
436
451
  content:
@@ -478,6 +493,9 @@ paths:
478
493
  message: Please provide a valid image resolution(dpi). Refer to the documentation for valid resolution values.
479
494
  schema:
480
495
  $ref: '#/components/schemas/ErrorResponse'
496
+ headers:
497
+ X-AF-Credits-Cost:
498
+ $ref: '#/components/headers/X-AF-Credits-Cost'
481
499
  /pdf/bmp:
482
500
  post:
483
501
  tags:
@@ -582,6 +600,9 @@ paths:
582
600
  taskId: 04a06cd5-158d-4191-a45b-6f58249c599d
583
601
  inputIds:
584
602
  - 7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f
603
+ headers:
604
+ X-AF-Credits-Cost:
605
+ $ref: '#/components/headers/X-AF-Credits-Cost'
585
606
  '400':
586
607
  description: Bad Request — Missing/invalid parameters or file ID
587
608
  content:
@@ -629,6 +650,9 @@ paths:
629
650
  message: Please provide a valid image resolution(dpi). Refer to the documentation for valid resolution values.
630
651
  schema:
631
652
  $ref: '#/components/schemas/ErrorResponse'
653
+ headers:
654
+ X-AF-Credits-Cost:
655
+ $ref: '#/components/headers/X-AF-Credits-Cost'
632
656
  /pdf/gif:
633
657
  post:
634
658
  tags:
@@ -734,6 +758,9 @@ paths:
734
758
  taskId: 04a06cd5-158d-4191-a45b-6f58249c599d
735
759
  inputIds:
736
760
  - 7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f
761
+ headers:
762
+ X-AF-Credits-Cost:
763
+ $ref: '#/components/headers/X-AF-Credits-Cost'
737
764
  '400':
738
765
  description: Bad Request — Missing/invalid parameters or file ID
739
766
  content:
@@ -781,6 +808,9 @@ paths:
781
808
  message: Please provide a valid image resolution(dpi). Refer to the documentation for valid resolution values.
782
809
  schema:
783
810
  $ref: '#/components/schemas/ErrorResponse'
811
+ headers:
812
+ X-AF-Credits-Cost:
813
+ $ref: '#/components/headers/X-AF-Credits-Cost'
784
814
  components:
785
815
  securitySchemes:
786
816
  ApiKeyAuthHeader:
@@ -839,6 +869,11 @@ components:
839
869
  type: string
840
870
  format: date-time
841
871
  description: Timestamp when the error occurred (ISO 8601).
872
+ headers:
873
+ X-AF-Credits-Cost:
874
+ description: Specifies the number of credits consumed by the current request.
875
+ schema:
876
+ type: integer
842
877
  security:
843
878
  - ApiKeyAuthHeader: []
844
879
  - ApiKeyAuthQuery: []
@@ -103,6 +103,9 @@ paths:
103
103
  taskId: 16cc979a-55b9-476c-bfef-0977314478ec
104
104
  inputIds:
105
105
  - 9c809ef8-583a-40f1-afe2-424d1d953b69
106
+ headers:
107
+ X-AF-Credits-Cost:
108
+ $ref: '#/components/headers/X-AF-Credits-Cost'
106
109
  '400':
107
110
  description: Bad Request — Missing/invalid parameters, file ID, or password
108
111
  content:
@@ -142,6 +145,9 @@ paths:
142
145
  message: Please provide a strong password. Refer to the documentation for password requirements.
143
146
  schema:
144
147
  $ref: '#/components/schemas/ErrorResponse'
148
+ headers:
149
+ X-AF-Credits-Cost:
150
+ $ref: '#/components/headers/X-AF-Credits-Cost'
145
151
  '415':
146
152
  description: Unsupported Media Type — File type not supported
147
153
  content:
@@ -157,6 +163,9 @@ paths:
157
163
  status: 415
158
164
  error: Unsupported File Type
159
165
  message: The provided file type is not supported. Refer to the documentation for valid file types.
166
+ headers:
167
+ X-AF-Credits-Cost:
168
+ $ref: '#/components/headers/X-AF-Credits-Cost'
160
169
  operationId: unrestrictPdf
161
170
  components:
162
171
  securitySchemes:
@@ -216,6 +225,11 @@ components:
216
225
  type: string
217
226
  format: date-time
218
227
  description: Timestamp when the error occurred (ISO 8601).
228
+ headers:
229
+ X-AF-Credits-Cost:
230
+ description: Specifies the number of credits consumed by the current request.
231
+ schema:
232
+ type: integer
219
233
  security:
220
234
  - ApiKeyAuthHeader: []
221
235
  - ApiKeyAuthQuery: []
@@ -97,6 +97,9 @@ paths:
97
97
  taskId: b59d27fa-9865-4ad8-8e7c-818eb263892b
98
98
  inputIds:
99
99
  - 0fb39c16-db08-4ac8-bb5f-51656f934aaa
100
+ headers:
101
+ X-AF-Credits-Cost:
102
+ $ref: '#/components/headers/X-AF-Credits-Cost'
100
103
  '400':
101
104
  description: Bad Request — Missing/invalid parameters or file ID
102
105
  content:
@@ -128,6 +131,9 @@ paths:
128
131
  timestamp: '2026-07-27T10:54:38.253Z'
129
132
  schema:
130
133
  $ref: '#/components/schemas/ErrorResponse'
134
+ headers:
135
+ X-AF-Credits-Cost:
136
+ $ref: '#/components/headers/X-AF-Credits-Cost'
131
137
  '415':
132
138
  description: Unsupported Media Type — File type not supported
133
139
  content:
@@ -143,6 +149,9 @@ paths:
143
149
  message: The provided file type is not supported. Refer to the documentation for valid file types.
144
150
  schema:
145
151
  $ref: '#/components/schemas/ErrorResponse'
152
+ headers:
153
+ X-AF-Credits-Cost:
154
+ $ref: '#/components/headers/X-AF-Credits-Cost'
146
155
  operationId: rotatePdfPages
147
156
  components:
148
157
  securitySchemes:
@@ -202,6 +211,11 @@ components:
202
211
  type: string
203
212
  format: date-time
204
213
  description: Timestamp when the error occurred (ISO 8601).
214
+ headers:
215
+ X-AF-Credits-Cost:
216
+ description: Specifies the number of credits consumed by the current request.
217
+ schema:
218
+ type: integer
205
219
  security:
206
220
  - ApiKeyAuthHeader: []
207
221
  - ApiKeyAuthQuery: []
@@ -125,6 +125,9 @@ paths:
125
125
  valid: false
126
126
  error: Invalid Number Format
127
127
  message: The input does not match the expected structure of a phone number.
128
+ headers:
129
+ X-AF-Credits-Cost:
130
+ $ref: '#/components/headers/X-AF-Credits-Cost'
128
131
  '400':
129
132
  description: Bad Request – Missing or malformed request body
130
133
  content:
@@ -140,6 +143,9 @@ paths:
140
143
  path: /v1.0/phone/validation/bulk
141
144
  status: 400
142
145
  timestamp: '2026-07-27T12:56:50.387Z'
146
+ headers:
147
+ X-AF-Credits-Cost:
148
+ $ref: '#/components/headers/X-AF-Credits-Cost'
143
149
  '404':
144
150
  description: Not Found – Wrong HTTP method used on the endpoint (e.g. GET instead of POST)
145
151
  content:
@@ -155,6 +161,9 @@ paths:
155
161
  path: /v1.0/phone/validation/bulk
156
162
  status: 404
157
163
  timestamp: '2026-07-27T12:58:41.535Z'
164
+ headers:
165
+ X-AF-Credits-Cost:
166
+ $ref: '#/components/headers/X-AF-Credits-Cost'
158
167
  '408':
159
168
  description: Request Timeout – Timed out while connecting to the remote server
160
169
  content:
@@ -170,6 +179,9 @@ paths:
170
179
  status: 408
171
180
  error: Request Timeout
172
181
  message: Timed out while connecting to the remote URL.
182
+ headers:
183
+ X-AF-Credits-Cost:
184
+ $ref: '#/components/headers/X-AF-Credits-Cost'
173
185
  '413':
174
186
  description: Payload Too Large – Request body exceeds the size limit
175
187
  content:
@@ -185,6 +197,9 @@ paths:
185
197
  path: /v1.0/phone/validation/bulk
186
198
  status: 413
187
199
  timestamp: '2026-07-27T12:57:03.711Z'
200
+ headers:
201
+ X-AF-Credits-Cost:
202
+ $ref: '#/components/headers/X-AF-Credits-Cost'
188
203
  '429':
189
204
  description: Rate Limit Exceeded – API rate limit exceeded
190
205
  content:
@@ -200,6 +215,9 @@ paths:
200
215
  status: 429
201
216
  error: Too Many Requests
202
217
  message: API rate limit exceeded.
218
+ headers:
219
+ X-AF-Credits-Cost:
220
+ $ref: '#/components/headers/X-AF-Credits-Cost'
203
221
  operationId: bulkValidatePhoneNumbers
204
222
  components:
205
223
  securitySchemes:
@@ -369,6 +387,11 @@ components:
369
387
  description: Standard error envelope returned by the API on failed requests.
370
388
  required:
371
389
  - message
390
+ headers:
391
+ X-AF-Credits-Cost:
392
+ description: Specifies the number of credits consumed by the current request.
393
+ schema:
394
+ type: integer
372
395
  security:
373
396
  - ApiKeyAuthHeader: []
374
397
  - ApiKeyAuthQuery: []
@@ -93,6 +93,9 @@ paths:
93
93
  region: US
94
94
  possible: false
95
95
  valid: false
96
+ headers:
97
+ X-AF-Credits-Cost:
98
+ $ref: '#/components/headers/X-AF-Credits-Cost'
96
99
  '400':
97
100
  description: Bad Request – e.g. missing required field or both region codes provided
98
101
  content:
@@ -148,6 +151,9 @@ paths:
148
151
  error: Number Too Long
149
152
  message: The phone number has more digits than any valid phone number can have.
150
153
  path: /v1.0/phone-number/info
154
+ headers:
155
+ X-AF-Credits-Cost:
156
+ $ref: '#/components/headers/X-AF-Credits-Cost'
151
157
  '404':
152
158
  description: Not Found – Wrong HTTP method used on the endpoint (e.g. GET instead of POST)
153
159
  content:
@@ -163,6 +169,9 @@ paths:
163
169
  path: /v1.0/phone/validation
164
170
  status: 404
165
171
  timestamp: '2026-07-27T12:56:14.351Z'
172
+ headers:
173
+ X-AF-Credits-Cost:
174
+ $ref: '#/components/headers/X-AF-Credits-Cost'
166
175
  '408':
167
176
  description: Request Timeout – Timed out while connecting to the remote server
168
177
  content:
@@ -178,6 +187,9 @@ paths:
178
187
  status: 408
179
188
  error: Request Timeout
180
189
  message: Timed out while connecting to the remote URL.
190
+ headers:
191
+ X-AF-Credits-Cost:
192
+ $ref: '#/components/headers/X-AF-Credits-Cost'
181
193
  '429':
182
194
  description: Rate Limit Exceeded – API rate limit exceeded
183
195
  content:
@@ -193,6 +205,9 @@ paths:
193
205
  status: 429
194
206
  error: Too Many Requests
195
207
  message: API rate limit exceeded.
208
+ headers:
209
+ X-AF-Credits-Cost:
210
+ $ref: '#/components/headers/X-AF-Credits-Cost'
196
211
  operationId: validatePhoneNumber
197
212
  components:
198
213
  securitySchemes:
@@ -339,6 +354,11 @@ components:
339
354
  description: Standard error envelope returned by the API on failed requests.
340
355
  required:
341
356
  - message
357
+ headers:
358
+ X-AF-Credits-Cost:
359
+ description: Specifies the number of credits consumed by the current request.
360
+ schema:
361
+ type: integer
342
362
  security:
343
363
  - ApiKeyAuthHeader: []
344
364
  - ApiKeyAuthQuery: []
@@ -142,6 +142,13 @@ paths:
142
142
  - <small class="author" itemprop="author">Thomas A. Edison</small>
143
143
  - <small class="author" itemprop="author">Eleanor Roosevelt</small>
144
144
  - <small class="author" itemprop="author">Steve Martin</small>
145
+ headers:
146
+ X-AF-Credits-Cost:
147
+ $ref: '#/components/headers/X-AF-Credits-Cost'
148
+ X-Concurrent-Threads:
149
+ $ref: '#/components/headers/X-Concurrent-Threads'
150
+ X-Concurrent-Threads-Active:
151
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
145
152
  '400':
146
153
  description: Bad Request — Missing/invalid parameters, malformed request body, unparseable selectors, or the target URL could not be fetched
147
154
  content:
@@ -197,6 +204,13 @@ paths:
197
204
  error: Bad Request
198
205
  message: Check the url or links
199
206
  path: /v1/scraping/params
207
+ headers:
208
+ X-AF-Credits-Cost:
209
+ $ref: '#/components/headers/X-AF-Credits-Cost'
210
+ X-Concurrent-Threads:
211
+ $ref: '#/components/headers/X-Concurrent-Threads'
212
+ X-Concurrent-Threads-Active:
213
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
200
214
  '404':
201
215
  description: Not Found — Wrong HTTP method or path used against this endpoint
202
216
  content:
@@ -212,6 +226,13 @@ paths:
212
226
  path: /v1.0/scraping
213
227
  status: 404
214
228
  timestamp: '2026-07-23T11:51:33.926Z'
229
+ headers:
230
+ X-AF-Credits-Cost:
231
+ $ref: '#/components/headers/X-AF-Credits-Cost'
232
+ X-Concurrent-Threads:
233
+ $ref: '#/components/headers/X-Concurrent-Threads'
234
+ X-Concurrent-Threads-Active:
235
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
215
236
  components:
216
237
  securitySchemes:
217
238
  ApiKeyAuthHeader:
@@ -474,6 +495,19 @@ components:
474
495
  type: string
475
496
  format: date-time
476
497
  description: Timestamp when the error occurred (ISO 8601).
498
+ headers:
499
+ X-AF-Credits-Cost:
500
+ description: Specifies the number of credits consumed by the current request.
501
+ schema:
502
+ type: integer
503
+ X-Concurrent-Threads:
504
+ description: Specifies the maximum number of concurrent requests allowed.
505
+ schema:
506
+ type: integer
507
+ X-Concurrent-Threads-Active:
508
+ description: Indicates the number of active concurrent requests being processed.
509
+ schema:
510
+ type: integer
477
511
  security:
478
512
  - ApiKeyAuthHeader: []
479
513
  - ApiKeyAuthQuery: []
@@ -80,6 +80,13 @@ paths:
80
80
  path: /v3/screenshot
81
81
  status: fulfilled
82
82
  error_message: null
83
+ headers:
84
+ X-AF-Credits-Cost:
85
+ $ref: '#/components/headers/X-AF-Credits-Cost'
86
+ X-Concurrent-Threads:
87
+ $ref: '#/components/headers/X-Concurrent-Threads'
88
+ X-Concurrent-Threads-Active:
89
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
83
90
  '400':
84
91
  description: Invalid request body
85
92
  content:
@@ -95,6 +102,13 @@ paths:
95
102
  timestamp: '2026-07-27T10:18:42.036Z'
96
103
  schema:
97
104
  $ref: '#/components/schemas/ErrorResponse'
105
+ headers:
106
+ X-AF-Credits-Cost:
107
+ $ref: '#/components/headers/X-AF-Credits-Cost'
108
+ X-Concurrent-Threads:
109
+ $ref: '#/components/headers/X-Concurrent-Threads'
110
+ X-Concurrent-Threads-Active:
111
+ $ref: '#/components/headers/X-Concurrent-Threads-Active'
98
112
  '413':
99
113
  description: Payload too large
100
114
  content:
@@ -110,6 +124,13 @@ paths:
110
124
  timestamp: '2026-07-27T10:18:57.172Z'
111
125
  schema:
112
126
  $ref: '#/components/schemas/ErrorResponse'
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'
113
134
  components:
114
135
  securitySchemes:
115
136
  ApiKeyAuthHeader:
@@ -723,6 +744,19 @@ components:
723
744
  type: string
724
745
  format: date-time
725
746
  description: Timestamp when the error occurred (ISO 8601).
747
+ headers:
748
+ X-AF-Credits-Cost:
749
+ description: Specifies the number of credits consumed by the current request.
750
+ schema:
751
+ type: integer
752
+ X-Concurrent-Threads:
753
+ description: Specifies the maximum number of concurrent requests allowed.
754
+ schema:
755
+ type: integer
756
+ X-Concurrent-Threads-Active:
757
+ description: Indicates the number of active concurrent requests being processed.
758
+ schema:
759
+ type: integer
726
760
  security:
727
761
  - ApiKeyAuthHeader: []
728
762
  - ApiKeyAuthQuery: []