@apifreaks/openapi-specs 0.2.0 → 0.3.0

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/general/usage-credits.yaml

@@ -53,6 +53,9 @@ paths:
                     oneOffCreditsActive: true
                     oneOffAllowedCredits: 5000
                     oneOffUsedCredits: 1000
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '403':
           description: Forbidden — Caller is not an organization admin
           content:
@@ -68,6 +71,9 @@ paths:
                     status: 403
                     error: API Access Exception
                     message: You need to be organization admin to access this endpoint.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -183,6 +189,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/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/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/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/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/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/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/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/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/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/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: []

package/dist/specs/geodb/subregions.yaml

@@ -77,6 +77,9 @@ paths:
                       - Western Africa
                       - Western Asia
                       - Western Europe
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Region name is not a recognized region
           content:
@@ -92,6 +95,9 @@ paths:
                     status: 400
                     error: Invalid Region Name provided
                     message: Please provide a valid region name.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — Region is valid but has no subregions (e.g. Polar)
           content:
@@ -107,6 +113,9 @@ paths:
                     status: 404
                     error: No subregions exist
                     message: This region does not have any subregions.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -153,6 +162,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/ip-intelligence/bulk-ip-lookup.yaml

@@ -315,6 +315,9 @@ paths:
                   summary: Bogon, reserved, or not-in-database IP — returns an error object for that item
                   value:
                     - message: '''127.0.0.1'' is a bogon IP address.'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Invalid or missing parameters
           content:
@@ -338,6 +341,9 @@ paths:
                     path: /v2.0/geolocation/lookup
                     status: 400
                     timestamp: '2026-07-22T13:09:02.595Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '413':
           description: Payload Too Large — Request body exceeds the maximum allowed size
           content:
@@ -353,6 +359,9 @@ paths:
                     path: /v2.0/geolocation/lookup
                     status: 413
                     timestamp: '2026-07-22T13:09:13.142Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -890,6 +899,11 @@ components:
           $ref: '#/components/schemas/Engine'
         operating_system:
           $ref: '#/components/schemas/OperatingSystem'
+  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/ip-intelligence/bulk-ip-threat-intelligence.yaml

@@ -137,6 +137,9 @@ paths:
                   summary: Bogon or reserved IP - returns an error object for that item
                   value:
                     - message: '''127.0.0.1'' is a bogon IP address.'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request - Missing, empty, or malformed request body
           content:
@@ -152,6 +155,9 @@ paths:
                     path: /v1.0/ip/security
                     status: 400
                     timestamp: '2026-07-22T14:03:26.577Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -305,6 +311,11 @@ components:
         cloud_provider_name:
           type: string
           description: Name of the cloud provider, if the IP address belongs to a cloud provider.
+  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/ip-intelligence/ip-locator.yaml

@@ -161,6 +161,9 @@ paths:
                         date_time_after: 2026-11-01 TIME 01:00
                         date_time_before: 2026-11-01 TIME 02:00
                         overlap: true
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Invalid or missing parameters
           content:
@@ -172,6 +175,9 @@ paths:
                   summary: Missing or invalid parameters
                   value:
                     message: The request was unacceptable. Typically due to missing or invalid parameters.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — IP address not in database
           content:
@@ -183,6 +189,9 @@ paths:
                   summary: IP address not in database
                   value:
                     message: Provided IP address '255.255.255.255' doesn't exist in our database.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '423':
           description: Locked — Bogon or reserved IP address
           content:
@@ -194,6 +203,9 @@ paths:
                   summary: Bogon or reserved IP address
                   value:
                     message: '''127.0.0.1'' is a bogon (Internet Assigned Numbers Authority) IP address.'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -703,6 +715,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/ip-intelligence/ip-threat-intelligence.yaml

@@ -79,6 +79,9 @@ paths:
                       is_spam: false
                       is_cloud_provider: true
                       cloud_provider_name: Google LLC
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Invalid or missing IP address
           content:
@@ -90,6 +93,9 @@ paths:
                   summary: Malformed IP address
                   value:
                     message: Provided IP address 'invalid' is not valid
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '423':
           description: Locked — Bogon or reserved IP address
           content:
@@ -101,6 +107,9 @@ paths:
                   summary: Bogon or reserved IP address
                   value:
                     message: '''10.0.0.1'' is a bogon IP address.'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -225,6 +234,11 @@ components:
         cloud_provider_name:
           type: string
           description: Cloud provider name.
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []