@apifreaks/openapi-specs 0.2.0 → 0.3.1

package/dist/specs/financial/bulk-vat-rates-country.yaml

@@ -86,6 +86,9 @@ paths:
                         newspapers: 0.07
                         periodicals: 0.07
                         broadcasting: 0
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing or malformed request body
           content:
@@ -101,6 +104,9 @@ paths:
                     path: /v1.0/vat/rates/country
                     status: 400
                     timestamp: '2026-07-27T11:46:29.315Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '413':
           description: Payload Too Large — Request body exceeds the size limit
           content:
@@ -116,6 +122,9 @@ paths:
                     path: /v1.0/vat/rates/country
                     status: 413
                     timestamp: '2026-07-27T11:46:29.925Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -245,6 +254,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/financial/financial-apis-supported-countries.yaml

@@ -65,6 +65,9 @@ paths:
                         countryCode: DE
                       - name: United States
                         countryCode: US
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -147,6 +150,11 @@ components:
         countryCode:
           type: string
           description: ISO 3166-1 alpha-2 country code.
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/financial/iban-validation.yaml

@@ -111,6 +111,9 @@ paths:
                       address: null
                       account: null
                       sepa: null
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request
           content:
@@ -126,6 +129,9 @@ paths:
                     path: /v1.0/iban/validation
                     status: 400
                     timestamp: '2026-07-27T11:49:29.286Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: validateIban
 components:
   securitySchemes:
@@ -265,6 +271,11 @@ components:
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
       description: Standard error envelope returned by the API on failed requests.
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/financial/swift-code-finder.yaml

@@ -87,6 +87,9 @@ paths:
                 noMatch:
                   summary: Unmatched country/bank/city — empty array, not an error
                   value: []
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Parameters supplied out of order
           content:
@@ -98,6 +101,9 @@ paths:
                   summary: bank supplied without country
                   value:
                     message: 'Invalid query parameters. Provide parameters in sequence: country → bank → city'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -141,6 +147,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/financial/swift-code-lookup.yaml

@@ -52,6 +52,9 @@ paths:
                     bankName: NATIONAL WESTMINSTER BANK PLC
                     city: LONDON
                     country: United Kingdom
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request
           content:
@@ -71,6 +74,9 @@ paths:
                   summary: swiftCode is not 8 or 11 characters
                   value:
                     message: 'Bad request: SWIFT code input must be either 8 characters or 11 characters'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found
           content:
@@ -82,6 +88,9 @@ paths:
                   summary: SWIFT code not found
                   value:
                     message: No bank found with the provided SWIFT code
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: lookupSwiftCode
 components:
   securitySchemes:
@@ -151,6 +160,11 @@ components:
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
       description: Standard error envelope returned by the API on failed requests.
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/financial/vat-number-validation.yaml

@@ -75,6 +75,9 @@ paths:
                     company:
                       company_name: EVENTURED LTD
                       company_address: SUITE 10, BEAUFORT COURT, ADMIRALS WAY, LONDON, E14 9XL, GB
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request
           content:
@@ -94,6 +97,9 @@ paths:
                   summary: Unsupported VAT country code
                   value:
                     message: Unsupported VAT country code. Supported prefixes are UK/GB and EU VAT country codes.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found
           content:
@@ -105,6 +111,9 @@ paths:
                   summary: VAT number not found
                   value:
                     message: targetVrn does not match a registered company
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: validateVatNumber
 components:
   securitySchemes:
@@ -200,6 +209,11 @@ components:
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
       description: Standard error envelope returned by the API on failed requests.
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/financial/vat-rates-by-ip.yaml

@@ -66,6 +66,9 @@ paths:
                       type: vat
                       currency: ''
                       standard_rate: 0.0825
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request
           content:
@@ -77,6 +80,9 @@ paths:
                   summary: Invalid IP address format
                   value:
                     message: Invalid IP address format. Please provide a valid IPv4 or IPv6 address.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found
           content:
@@ -88,6 +94,9 @@ paths:
                   summary: VAT data not found for IP
                   value:
                     message: No VAT data found. Please provide a valid ipAddress.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -195,6 +204,11 @@ components:
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
       description: Standard error envelope returned by the API on failed requests.
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/financial/vat-rates-country.yaml

@@ -72,6 +72,9 @@ paths:
                       type: vat
                       currency: ''
                       standard_rate: 0.04
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing required country parameter
           content:
@@ -87,6 +90,9 @@ paths:
                     path: /v1.0/vat/rates/country
                     status: 400
                     timestamp: '2026-07-27T11:45:34.183Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — No VAT data for the given country/state
           content:
@@ -98,6 +104,9 @@ paths:
                   summary: No VAT data for the given country
                   value:
                     message: No VAT data found.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -207,6 +216,11 @@ components:
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
       description: Standard error envelope returned by the API on failed requests.
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/geocoding/forward-geocoding.yaml

@@ -110,6 +110,9 @@ paths:
                         - '51.5573402'
                         - '-0.2817245'
                         - '-0.2774831'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Invalid or missing parameters
           content:
@@ -149,6 +152,9 @@ paths:
                     path: /v1.0/geocoder/search
                     status: 400
                     timestamp: '2026-07-22T14:30:11.104Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — No results matched the query
           content:
@@ -164,6 +170,9 @@ paths:
                     path: /v1.0/geocoder/search
                     status: 404
                     timestamp: '2026-07-22T14:29:58.349Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -287,6 +296,11 @@ components:
         type:
           type: string
           description: Specific kind within the category, e.g. fast_food, city, park, residential, house_number.
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/geocoding/reverse-geocoding.yaml

@@ -76,6 +76,9 @@ paths:
                       - '40.7490169'
                       - '-73.9854490'
                       - '-73.9853490'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Invalid or missing parameters
           content:
@@ -115,6 +118,9 @@ paths:
                     path: /v1.0/geocoder/reverse
                     status: 400
                     timestamp: '2026-07-22T14:29:46.809Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -232,6 +238,11 @@ components:
         type:
           type: string
           description: Specific kind within the category, e.g. fast_food, city, park, residential, house_number.
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/{geodb → geography}/administrative-units-details.yaml

@@ -66,6 +66,9 @@ paths:
                     admin_level: military postal region
                     country_iso3166_2: US
                     country_name: United States
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing country/admin_unit parameter, invalid country code, or invalid admin code
           content:
@@ -97,6 +100,9 @@ paths:
                     status: 400
                     error: Invalid Admin Code provided
                     message: Please provide a valid admin code.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — Country is a recognized ISO 3166-1 alpha-2 code but has no published admin units (e.g. Vatican City)
           content:
@@ -112,6 +118,9 @@ paths:
                     status: 404
                     error: No Admin Unit present in country
                     message: This Country does not have any admin units associated with it.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -175,6 +184,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/{geodb → geography}/administrative-units-levels.yaml

@@ -51,6 +51,9 @@ paths:
                       - district
                       - state
                       - military postal region
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing country parameter, or country is not a valid/known ISO 3166-1 alpha-2 code
           content:
@@ -74,6 +77,9 @@ paths:
                     status: 400
                     error: Invalid Country Code provided
                     message: Only ISO 3166-1 alpha-2 codes country codes are supported.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — Country is a recognized ISO 3166-1 alpha-2 code but has no published admin levels (e.g. Vatican City)
           content:
@@ -89,6 +95,9 @@ paths:
                     status: 404
                     error: No Admin Unit present in country
                     message: This Country does not have any admin units associated with it.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -135,6 +144,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/{geodb → geography}/administrative-units.yaml

@@ -62,6 +62,9 @@ paths:
                       - name: New York
                         admin_code: NY
                         admin_level: state
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing country parameter, or country is not a valid/known ISO 3166-1 alpha-2 code
           content:
@@ -85,6 +88,9 @@ paths:
                     status: 400
                     error: Invalid Country Code provided
                     message: Only ISO 3166-1 alpha-2 codes country codes are supported.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — Country is a recognized ISO 3166-1 alpha-2 code but has no published admin units (e.g. Vatican City)
           content:
@@ -100,6 +106,9 @@ paths:
                     status: 404
                     error: No Admin Unit present in country
                     message: This Country does not have any admin units associated with it.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -163,6 +172,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/{geodb → geography}/cities.yaml

@@ -69,6 +69,9 @@ paths:
                           admin_code: ABE
                           admin_level: council area
                         iso_alpha_2: GB
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing country parameter, invalid country code, or admin_unit code not found for the country
           content:
@@ -100,6 +103,9 @@ paths:
                     status: 400
                     error: Invalid Admin Code provided
                     message: Please provide a valid admin code.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — Country is a recognized ISO 3166-1 alpha-2 code but has no cities in the database (e.g. Vatican City)
           content:
@@ -115,6 +121,9 @@ paths:
                     status: 404
                     error: No Cities present in country
                     message: This country does not have any cities associated with it.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -204,6 +213,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/{geodb → geography}/countries-details.yaml

@@ -79,6 +79,9 @@ paths:
                     currency_code: NOK
                     currency_name: Norwegian krone
                     currency_symbol: ko
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing country parameter, or country is not a valid/known ISO 3166-1 alpha-2 code
           content:
@@ -102,6 +105,9 @@ paths:
                     status: 400
                     error: Invalid Country Code provided
                     message: Only ISO 3166-1 alpha-2 codes country codes are supported.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -202,6 +208,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/{geodb → geography}/countries.yaml

@@ -92,6 +92,9 @@ paths:
                         capital: ''
                         region: Polar
                         subregion: ''
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Invalid region or subregion name
           content:
@@ -115,6 +118,9 @@ paths:
                     status: 400
                     error: Invalid Subregion Name provided
                     message: Please provide a valid subregion name.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -194,6 +200,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/{geodb → geography}/flags-supported.yaml

@@ -67,6 +67,9 @@ paths:
                       - NATO
                       - Association_of_Southeast_Asian_Nations
                       - Commonwealth_of_Nations
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -114,6 +117,11 @@ components:
         iso3:
           type: string
           description: ISO 3166-1 alpha-3 code.
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/{geodb → geography}/flags.yaml

@@ -79,6 +79,9 @@ paths:
             image/svg+xml:
               schema:
                 $ref: '#/components/schemas/ApiResponseSchemas'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing required parameter, or type/shape/format/size is not one of the allowed enum values
           content:
@@ -110,6 +113,9 @@ paths:
                     status: 400
                     error: Bad Request
                     message: Invalid shape
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — Country code or organization identifier not recognized
           content:
@@ -125,6 +131,9 @@ paths:
                     status: 404
                     error: Not Found
                     message: 'Invalid country name or code: ZZ'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -165,6 +174,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/{geodb → geography}/regions.yaml

@@ -47,6 +47,9 @@ paths:
                       - Europe
                       - Oceania
                       - Polar
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -71,6 +74,11 @@ components:
           description: An array of region names representing all geographical regions supported by the service.
           items:
             type: string
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []