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/portscan-com:portscan-com-fast-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: portscan.com Fast API
  version: 1.0.0
  description: Free port scanner API. Scans the IP address of the requesting server. No API key required.
  contact:
    name: Abuse contact
    email: abuse@portscan.com
    url: https://portscan.com/abuse
  license:
    name: Proprietary
    url: https://portscan.com/terms
servers:
- url: https://api.portscan.com
tags:
- name: Fast
paths:
  /v1/fast:
    post:
      summary: Start a fast scan (32 ports)
      operationId: startFastScan
      parameters:
      - name: X-Callback-Url
        in: header
        required: false
        schema:
          type: string
          format: uri
        description: Webhook URL for completion
      responses:
        '200':
          description: Scan queued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanQueued'
        '403':
          description: IP opted out
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Invalid target IP
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds until reset
      tags:
      - Fast
    get:
      summary: Poll fast scan results
      operationId: pollFastScan
      responses:
        '200':
          description: Scan result or status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanResult'
      tags:
      - Fast
  /v2/fast:
    get:
      summary: Start and stream a fast scan (SSE)
      operationId: streamFastScan
      description: 'Single-request streaming. Starts a scan for the caller IP (if none is active) and streams progress over Server-Sent Events: scan:queued, scan:progress, then a terminal scan:complete or scan:failed. A blocked start (invalid target, opt-out, rate limit) returns the JSON error instead.'
      responses:
        '200':
          description: SSE event stream
          content:
            text/event-stream:
              schema:
                type: string
      tags:
      - Fast
components:
  schemas:
    ScanResult:
      type: object
      properties:
        ip:
          type: string
        scan_type:
          type: string
          enum:
          - fast
          - deep
        status:
          type: string
          enum:
          - queued
          - running
          - complete
          - incomplete
          - failed
          - none
          description: '''incomplete'' = host too slow or filtered to finish the full range; ports_open holds what was found, partial=true. Never treat as a complete result.'
        ports_open:
          type: array
          items:
            $ref: '#/components/schemas/Port'
        ports_filtered:
          type: array
          items:
            $ref: '#/components/schemas/Port'
        service_banners:
          type: object
          additionalProperties:
            type: string
        ptr_record:
          type: string
          nullable: true
        queue_position:
          type: integer
          description: Number of scans ahead of this one (only present while queued or running)
        duration_ms:
          type: integer
        completed_at:
          type: integer
        expires_at:
          type: integer
        fail_reason:
          type: string
          nullable: true
        partial:
          type: boolean
          description: 'True when status is incomplete: results are partial, not a full scan of the range.'
        chunks_complete:
          type: integer
        total_chunks:
          type: integer
    ScanQueued:
      type: object
      properties:
        ip:
          type: string
        scan_type:
          type: string
          enum:
          - fast
          - deep
        status:
          type: string
          enum:
          - queued
          - running
          description: queued for a fresh scan, or running when coalesced onto an in-flight scan for this IP
        eta_seconds:
          type: integer
        chunks_complete:
          type: integer
        total_chunks:
          type: integer
    Port:
      type: object
      properties:
        port:
          type: integer
        state:
          type: string
          enum:
          - open
          - closed
          - filtered
        service:
          type: string
          nullable: true
        banner:
          type: string
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
        reason:
          type: string
        retry_after:
          type: integer