@apifreaks/openapi-specs 0.1.2 → 0.3.0

package/dist/specs/whois/whois-ip-lookup.yaml

@@ -169,6 +169,9 @@ paths:
                       #
                       # Copyright 1997-2026, American Registry for Internet Numbers, Ltd.
                       #
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '206':
           description: Partial Content -- The WHOIS server returned an incomplete response. Some fields may be missing or truncated.
           content:
@@ -184,6 +187,9 @@ paths:
                     error: Partial Response
                     message: Partial response due to an error occurred while processing the request.
                     path: /v1.0/ip/whois/live
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request -- Missing or invalid ip parameter
           content:
@@ -207,6 +213,9 @@ paths:
                     error: Input parameter is not valid
                     message: Request-param 'ip' (not-an-ip) is not an IP address
                     path: /v1.0/ip-whois
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -1118,6 +1127,11 @@ components:
             - string
             - 'null'
           description: WHOIS data source for this route object.
+  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/zip-code/bulk-zip-code-lookup.yaml

@@ -83,6 +83,9 @@ paths:
                         locality: Manhattan
                         latitude: 40.748436
                         longitude: -73.99402
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Malformed body, invalid country code, or over the 100-code limit
           content:
@@ -114,6 +117,9 @@ paths:
                     status: 400
                     error: Maximum Postal/Zip Code Limit Exceeded
                     message: A maximum of 100 postal/zip codes can be processed per request.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — None of the submitted codes matched anything
           content:
@@ -129,6 +135,9 @@ paths:
                     status: 404
                     error: Postal/Zip Codes Not Found
                     message: None of the provided postal/zip codes were found in our database.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -227,6 +236,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/zip-code/zip-code-api.yaml

@@ -89,6 +89,9 @@ paths:
                         locality: Kalia
                         latitude: -1.310763
                         longitude: 37.969997
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing code or invalid country code
           content:
@@ -112,6 +115,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 — No location matches the given code
           content:
@@ -127,6 +133,9 @@ paths:
                     status: 404
                     error: Postal/Zip Code Not Found
                     message: Provided postal/zip code was not found in our database.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -211,6 +220,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/zip-code/zip-code-distance-match.yaml

@@ -71,6 +71,9 @@ paths:
                   value:
                     result_count: 0
                     results: []
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid body, country, or unit, or over the 100-code limit
           content:
@@ -118,6 +121,9 @@ paths:
                     status: 400
                     error: Maximum Postal/Zip Code Limit Exceeded
                     message: A maximum of 100 postal/zip codes can be processed per request.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — None of the submitted codes matched anything
           content:
@@ -133,6 +139,9 @@ paths:
                     status: 404
                     error: Postal/Zip Codes Not Found
                     message: None of the provided postal/zip codes were found in our database.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -234,6 +243,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/zip-code/zip-code-distance.yaml

@@ -62,6 +62,9 @@ paths:
                         distance: 3948.696
                       - code: '94103'
                         distance: 544.134
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid body, country, or unit, or over the 100-code limit
           content:
@@ -109,6 +112,9 @@ paths:
                     status: 400
                     error: Maximum Postal/Zip Code Limit Exceeded
                     message: A maximum of 100 postal/zip codes can be processed per request.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — None of the compare codes matched anything
           content:
@@ -124,6 +130,9 @@ paths:
                     status: 404
                     error: Postal/Zip Codes Not Found
                     message: None of the provided postal/zip codes were found in our database.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -228,6 +237,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/zip-code/zip-codes-by-city.yaml

@@ -77,6 +77,9 @@ paths:
                       - '90210'
                       - '90211'
                       - '90212'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing city, invalid country code, or invalid page number
           content:
@@ -108,6 +111,9 @@ paths:
                     status: 400
                     error: Invalid Page Number
                     message: The page number must be greater than 0.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — No codes for the city, or requested page is out of range
           content:
@@ -131,6 +137,9 @@ paths:
                     status: 404
                     error: Page Not Found
                     message: The requested page exceeds the available page range.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -196,6 +205,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/zip-code/zip-codes-by-region.yaml

@@ -76,6 +76,9 @@ paths:
                       - '90003'
                       - '90004'
                       - '90005'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing region/region_code, invalid country code, or invalid page number
           content:
@@ -107,6 +110,9 @@ paths:
                     status: 400
                     error: Invalid Page Number
                     message: The page number must be greater than 0.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found — No codes for the region, or requested page is out of range
           content:
@@ -130,6 +136,9 @@ paths:
                     status: 404
                     error: Page Not Found
                     message: The requested page exceeds the available page range.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -195,6 +204,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/zip-code/zip-codes-radius-search.yaml

@@ -112,6 +112,13 @@ paths:
                         city: Los Angeles
                         district: West Hollywood (West Hollywood)
                         distance: 3.403
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+            X-Concurrent-Threads:
+              $ref: '#/components/headers/X-Concurrent-Threads'
+            X-Concurrent-Threads-Active:
+              $ref: '#/components/headers/X-Concurrent-Threads-Active'
         '400':
           description: Bad Request — Missing/invalid radius, coordinates, or country code
           content:
@@ -151,6 +158,13 @@ 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'
+            X-Concurrent-Threads:
+              $ref: '#/components/headers/X-Concurrent-Threads'
+            X-Concurrent-Threads-Active:
+              $ref: '#/components/headers/X-Concurrent-Threads-Active'
         '404':
           description: Not Found — Base ZIP/postal code does not exist
           content:
@@ -166,6 +180,13 @@ paths:
                     status: 404
                     error: Base Postal/Zip Code Not Found
                     message: The provided base postal/zip code does not exist in our database.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+            X-Concurrent-Threads:
+              $ref: '#/components/headers/X-Concurrent-Threads'
+            X-Concurrent-Threads-Active:
+              $ref: '#/components/headers/X-Concurrent-Threads-Active'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -257,6 +278,19 @@ 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
+    X-Concurrent-Threads:
+      description: Specifies the maximum number of concurrent requests allowed.
+      schema:
+        type: integer
+    X-Concurrent-Threads-Active:
+      description: Indicates the number of active concurrent requests being processed.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apifreaks/openapi-specs",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "Public OpenAPI 3.1 specifications for all APIFreaks API products.",
   "type": "module",
   "main": "./dist/index.js",

package/specs/commodity/commodity-fluctuation.json

@@ -96,6 +96,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "400": {
@@ -148,6 +153,11 @@
                   "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "404": {
@@ -180,6 +190,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         }
@@ -288,6 +303,14 @@
           }
         }
       }
+    },
+    "headers": {
+      "X-AF-Credits-Cost": {
+        "description": "Specifies the number of credits consumed by the current request.",
+        "schema": {
+          "type": "integer"
+        }
+      }
     }
   },
   "security": [

package/specs/commodity/commodity-prices.json

@@ -113,6 +113,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "400": {
@@ -145,6 +150,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "404": {
@@ -177,6 +187,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         }
@@ -304,6 +319,14 @@
           }
         }
       }
+    },
+    "headers": {
+      "X-AF-Credits-Cost": {
+        "description": "Specifies the number of credits consumed by the current request.",
+        "schema": {
+          "type": "integer"
+        }
+      }
     }
   },
   "security": [

package/specs/commodity/commodity-symbols.json

@@ -87,6 +87,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         }
@@ -202,6 +207,14 @@
           }
         }
       }
+    },
+    "headers": {
+      "X-AF-Credits-Cost": {
+        "description": "Specifies the number of credits consumed by the current request.",
+        "schema": {
+          "type": "integer"
+        }
+      }
     }
   },
   "security": [

package/specs/commodity/commodity-time-series.json

@@ -19,9 +19,7 @@
   "paths": {
     "/commodity/time-series": {
       "get": {
-        "tags": [
-          "Commodity APIs"
-        ],
+        "tags": ["Commodity APIs"],
         "summary": "Get commodity price time series",
         "description": "Returns day-by-day OHLC data for the requested commodity symbols within a date range.",
         "operationId": "getCommodityTimeSeries",
@@ -34,9 +32,7 @@
             "schema": {
               "type": "string",
               "default": "json",
-              "enum": [
-                "json"
-              ]
+              "enum": ["json"]
             }
           },
           {
@@ -112,10 +108,15 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "400": {
-            "description": "Bad Request \u2014 Missing parameters, invalid dates, or date range exceeded",
+            "description": "Bad Request — Missing parameters, invalid dates, or date range exceeded",
             "content": {
               "application/json": {
                 "examples": {
@@ -164,6 +165,11 @@
                   "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "404": {
@@ -196,6 +202,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         }
@@ -220,12 +231,7 @@
     "schemas": {
       "CommodityTimeSeriesResponse": {
         "type": "object",
-        "required": [
-          "success",
-          "startDate",
-          "endDate",
-          "rates"
-        ],
+        "required": ["success", "startDate", "endDate", "rates"],
         "properties": {
           "success": {
             "type": "boolean",
@@ -316,6 +322,14 @@
           }
         }
       }
+    },
+    "headers": {
+      "X-AF-Credits-Cost": {
+        "description": "Specifies the number of credits consumed by the current request.",
+        "schema": {
+          "type": "integer"
+        }
+      }
     }
   },
   "security": [

package/specs/commodity/historical-commodity-prices.json

@@ -88,6 +88,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "400": {
@@ -120,6 +125,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "404": {
@@ -152,6 +162,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         }
@@ -260,6 +275,14 @@
         },
         "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": [

package/specs/currency/currency-converter.json

@@ -97,6 +97,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "400": {
@@ -139,6 +144,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "404": {
@@ -161,6 +171,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         }
@@ -248,6 +263,14 @@
           }
         }
       }
+    },
+    "headers": {
+      "X-AF-Credits-Cost": {
+        "description": "Specifies the number of credits consumed by the current request.",
+        "schema": {
+          "type": "integer"
+        }
+      }
     }
   },
   "security": [