find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hacktron:hacktron-rest-api-hfw-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Hacktron REST API - HFW API
  version: '1.0'
  contact: {}
  description: 'Operations tagged REST API - HFW across 2 of this provider''s published API definitions: hacktron-openapi.json, openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.hacktron.ai/v1
security:
- api-key: []
tags:
- name: REST API - HFW
paths:
  /hfw/verdicts/batch:
    post:
      description: Public, fast-mode HFW batch verdict proxy. This endpoint is intentionally scoped to feed-backed verdicts and can be moved behind X-Api-Key later.
      operationId: RestHfwController_getBatchVerdicts
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestHfwBatchRequestDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestHfwBatchResponseDto'
      security: []
      summary: Get fast dependency verdicts for landing and GitHub Action scans
      tags:
      - REST API - HFW
    servers:
    - url: https://api.hacktron.ai/v1
  /hfw/osv/feed:
    get:
      operationId: RestHfwController_getOsvFeed
      parameters:
      - name: limit
        required: false
        in: query
        schema:
          minimum: 1
          maximum: 500
          default: 200
          type: number
      - name: offset
        required: false
        in: query
        schema:
          minimum: 0
          default: 0
          type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestHfwOsvFeedResponseDto'
      security: []
      summary: List known-malware feed entries for package sitemap generation
      tags:
      - REST API - HFW
    servers:
    - url: https://api.hacktron.ai/v1
  /hfw/verdict/{ecosystem}/{packageName}:
    get:
      description: Public, fast-mode HFW verdict proxy. This endpoint is intentionally scoped to feed-backed verdicts and can be moved behind X-Api-Key later.
      operationId: RestHfwController_getPackageVerdict
      parameters:
      - name: version
        required: true
        in: query
        description: Package version to check
        schema:
          type: string
      - name: wait_seconds
        required: false
        in: query
        description: Seconds to wait for an upstream verdict. Fast mode normally returns immediately.
        schema:
          minimum: 0
          maximum: 60
          default: 0
          type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestHfwVerdictResponseDto'
      security: []
      summary: Get a fast dependency verdict for GitHub Action scans
      tags:
      - REST API - HFW
    servers:
    - url: https://api.hacktron.ai/v1
  /hfw/verdict/{ecosystem}/{scope}/{packageName}:
    get:
      operationId: RestHfwController_getScopedNpmPackageVerdict
      parameters:
      - name: version
        required: true
        in: query
        description: Package version to check
        schema:
          type: string
      - name: wait_seconds
        required: false
        in: query
        description: Seconds to wait for an upstream verdict. Fast mode normally returns immediately.
        schema:
          minimum: 0
          maximum: 60
          default: 0
          type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestHfwVerdictResponseDto'
      security: []
      summary: Get a fast dependency verdict for scoped npm GitHub Action scans
      tags:
      - REST API - HFW
    servers:
    - url: https://api.hacktron.ai/v1
components:
  schemas:
    RestHfwVerdictResponseDto:
      type: object
      properties:
        status:
          type: string
          enum:
          - ready
          - pending
          - scanning
        ecosystem:
          type: string
          enum:
          - npm
          - pypi
        package:
          type: string
        version:
          type: string
        level:
          type: string
          enum:
          - clean
          - suspicious
          - malicious
          - unknown
        confidence:
          type: string
        summary:
          type: string
        findings:
          type: array
          items:
            type: object
        source:
          type: string
        osv_id:
          type: string
      required:
      - status
      - ecosystem
      - package
      - version
      - level
      - confidence
      - summary
      - findings
    RestHfwOsvFeedResponseDto:
      type: object
      properties:
        total:
          type: number
        results:
          type: array
          items:
            $ref: '#/components/schemas/RestHfwOsvFeedResultDto'
      required:
      - results
    RestHfwBatchRequestDto:
      type: object
      properties:
        packages:
          type: array
          items:
            $ref: '#/components/schemas/RestHfwBatchPackageDto'
      required:
      - packages
    RestHfwBatchResponseDto:
      type: object
      properties:
        status:
          type: string
        verdicts:
          type: array
          items:
            $ref: '#/components/schemas/RestHfwVerdictResponseDto'
        errors:
          type: array
          items:
            type: object
      required:
      - status
      - verdicts
      - errors
    RestHfwOsvFeedResultDto:
      type: object
      properties:
        ecosystem:
          type: string
        package:
          type: string
        versions:
          type: array
          items:
            type: string
      required:
      - ecosystem
      - package
      - versions
    RestHfwBatchPackageDto:
      type: object
      properties:
        ecosystem:
          type: string
          enum:
          - npm
          - pypi
        package:
          type: string
        version:
          type: string
      required:
      - ecosystem
      - package
      - version
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-Api-Key
x-refined-from:
- hacktron-openapi.json
- openapi.json