Port Scanner - Geekflare

curl --request POST \
  --url https://api.geekflare.com/openport \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com"
}
'

{
  "timestamp": 1788851167291,
  "apiStatus": "success",
  "apiCode": 200,
  "meta": {
    "url": "https://example.com",
    "test": {
      "id": "mxqx9v9y0742lap6altwdteqd28t23nq"
    },
    "topPorts": 100,
    "portRanges": "80,443,1000-1010",
    "detectServices": false
  },
  "data": [
    123
  ],
  "services": [
    {
      "port": 22,
      "state": "open",
      "service": {
        "name": "ssh",
        "product": "OpenSSH",
        "version": "8.9p1",
        "extraInfo": "Ubuntu Linux; protocol 2.0",
        "osType": "Linux"
      }
    }
  ],
  "servicesError": "Service detection could not complete for this target; the port list above is still accurate."
}

{
  "timestamp": 1700000000000,
  "apiStatus": "failure",
  "apiCode": 400,
  "message": "INVALID_URL",
  "details": "The URL must be a valid HTTP or HTTPS URL."
}

{
  "timestamp": 1700000000000,
  "apiStatus": "failure",
  "apiCode": 408,
  "message": "NMAP_TIMEOUT",
  "details": "The port scan timed out before it could complete."
}

{
  "timestamp": 1700000000000,
  "apiStatus": "failure",
  "apiCode": 500,
  "message": "PORT_SCAN_FAILED",
  "details": "Our port scanning service encountered an unexpected error while attempting to scan the target."
}

POST

/

openport

curl --request POST \
  --url https://api.geekflare.com/openport \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com"
}
'

{
  "timestamp": 1788851167291,
  "apiStatus": "success",
  "apiCode": 200,
  "meta": {
    "url": "https://example.com",
    "test": {
      "id": "mxqx9v9y0742lap6altwdteqd28t23nq"
    },
    "topPorts": 100,
    "portRanges": "80,443,1000-1010",
    "detectServices": false
  },
  "data": [
    123
  ],
  "services": [
    {
      "port": 22,
      "state": "open",
      "service": {
        "name": "ssh",
        "product": "OpenSSH",
        "version": "8.9p1",
        "extraInfo": "Ubuntu Linux; protocol 2.0",
        "osType": "Linux"
      }
    }
  ],
  "servicesError": "Service detection could not complete for this target; the port list above is still accurate."
}

{
  "timestamp": 1700000000000,
  "apiStatus": "failure",
  "apiCode": 400,
  "message": "INVALID_URL",
  "details": "The URL must be a valid HTTP or HTTPS URL."
}

{
  "timestamp": 1700000000000,
  "apiStatus": "failure",
  "apiCode": 408,
  "message": "NMAP_TIMEOUT",
  "details": "The port scan timed out before it could complete."
}

{
  "timestamp": 1700000000000,
  "apiStatus": "failure",
  "apiCode": 500,
  "message": "PORT_SCAN_FAILED",
  "details": "Our port scanning service encountered an unexpected error while attempting to scan the target."
}

Authorizations

x-api-key

string

header

required

API Key required for all endpoints

Body

application/json

url

string

required

The URL, hostname, IPv4, or IPv6 address to be checked

Example:

"https://example.com"

topPorts

enum<number>

Scan only the top N ports (optional)

Available options:

50,

100,

500,

1000,

5000

Example:

100

portRanges

string

Custom port ranges to scan, e.g., "80,443,1000-1010"

Example:

"80,443,1000-1010"

detectServices

boolean

default:false

When true, also runs service/version detection (nmap -sV) on the ports found open. Slower than the base scan since it probes each open port individually — best-effort: if it fails, the port list is still returned without service info.

Example:

false

Response

Open ports retrieved successfully

timestamp

number

required

Timestamp of the request in milliseconds

Example:

1788851167291

apiStatus

enum<string>

required

API status message

Available options:

success,

failure

Example:

"success"

apiCode

number

required

API status code

Example:

200

meta

object

required

Metadata about the request

Show child attributes

data

number[]

required

List of open ports found

services

object[]

Service/version detection results, present only when detectServices was requested and succeeded

Show child attributes

servicesError

string

Present only when detectServices was requested but could not complete (e.g. nmap error/timeout) — the port list in data is still accurate regardless

Example:

"Service detection could not complete for this target; the port list above is still accurate."