Port Scan

POSThttps://api.deepinfo.com/v1/lookup/port-scan

Scans a host in real time and returns its open TCP/UDP ports and the services running on them. Optionally detects service versions and the operating system.

Only scan hosts you own or are authorized to test.

Example

Request

curl

curl -X POST 'https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "tcp_ports": "80,443",
  "mode": "light",
  "version": true
}'

Python

import requests

url = "https://api.deepinfo.com/v1/lookup/port-scan"

params = {
    "target": "deepinfo.com"
}

headers = {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
}

payload = {
    "tcp_ports": "80,443",
    "mode": "light",
    "version": True
}

response = requests.post(url, params=params, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const url = "https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    tcp_ports: "80,443",
    mode: "light",
    version: true
  }),
});

const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{
  "tcp_ports": "80,443",
  "mode": "light",
  "version": true
}`)

	req, err := http.NewRequest("POST", "https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com", payload)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "tcp_ports": "80,443",
              "mode": "light",
              "version": true
            }""";

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com"))
            .header("apikey", "YOUR_API_KEY")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

var body = """
    {
      "tcp_ports": "80,443",
      "mode": "light",
      "version": true
    }
    """;

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com");
request.Headers.Add("apikey", "YOUR_API_KEY");
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$body = <<<'JSON'
{
  "tcp_ports": "80,443",
  "mode": "light",
  "version": true
}
JSON;

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'apikey: YOUR_API_KEY',
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

$response = curl_exec($curl);

if ($response === false) {
    throw new RuntimeException(curl_error($curl));
}

echo $response . PHP_EOL;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com')

request = Net::HTTP::Post.new(uri)
request['apikey'] = 'YOUR_API_KEY'
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = <<~'JSON'.chomp
  {
    "tcp_ports": "80,443",
    "mode": "light",
    "version": true
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

puts response.body

Response

200 OK · application/json

Response Body

{
  "status": "success",
  "target": "deepinfo.com",
  "target_ip": "104.26.11.21",
  "check_date": "2026-09-22T16:06:23Z",
  "port_data": {
    "tcp": [
      {
        "port_number": 80,
        "service_name": "http",
        "service_product": null,
        "service_version": null,
        "state": "open",
        "extra_data": {}
      },
      {
        "port_number": 443,
        "service_name": "https",
        "service_product": null,
        "service_version": null,
        "state": "open",
        "extra_data": {}
      }
    ],
    "udp": []
  },
  "os": []
}

Content-Type: application/json
deepinfo-request-id: 5f0c6a8e-1b2d-4c3e-9f4a-7b8c9d0e1f2a

Request

curl

curl -X POST 'https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "tcp_ports": "440-445",
  "mode": "light"
}'

Python

import requests

url = "https://api.deepinfo.com/v1/lookup/port-scan"

params = {
    "target": "deepinfo.com"
}

headers = {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
}

payload = {
    "tcp_ports": "440-445",
    "mode": "light"
}

response = requests.post(url, params=params, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const url = "https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    tcp_ports: "440-445",
    mode: "light"
  }),
});

const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{
  "tcp_ports": "440-445",
  "mode": "light"
}`)

	req, err := http.NewRequest("POST", "https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com", payload)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "tcp_ports": "440-445",
              "mode": "light"
            }""";

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com"))
            .header("apikey", "YOUR_API_KEY")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

var body = """
    {
      "tcp_ports": "440-445",
      "mode": "light"
    }
    """;

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com");
request.Headers.Add("apikey", "YOUR_API_KEY");
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$body = <<<'JSON'
{
  "tcp_ports": "440-445",
  "mode": "light"
}
JSON;

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'apikey: YOUR_API_KEY',
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

$response = curl_exec($curl);

if ($response === false) {
    throw new RuntimeException(curl_error($curl));
}

echo $response . PHP_EOL;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.deepinfo.com/v1/lookup/port-scan?target=deepinfo.com')

request = Net::HTTP::Post.new(uri)
request['apikey'] = 'YOUR_API_KEY'
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = <<~'JSON'.chomp
  {
    "tcp_ports": "440-445",
    "mode": "light"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

puts response.body

Response

200 OK · application/json

Response Body

{
  "status": "success",
  "target": "deepinfo.com",
  "target_ip": "104.26.11.21",
  "check_date": "2026-09-22T16:06:26Z",
  "port_data": {
    "tcp": [
      {
        "port_number": 440,
        "service_name": "sgcp",
        "service_product": null,
        "service_version": null,
        "state": "filtered",
        "extra_data": {}
      },
      {
        "port_number": 441,
        "service_name": "decvms-sysmgt",
        "service_product": null,
        "service_version": null,
        "state": "filtered",
        "extra_data": {}
      },
      {
        "port_number": 442,
        "service_name": "cvc_hostd",
        "service_product": null,
        "service_version": null,
        "state": "filtered",
        "extra_data": {}
      }
    ],
    "udp": []
  },
  "os": []
}

Content-Type: application/json
deepinfo-request-id: 5f0c6a8e-1b2d-4c3e-9f4a-7b8c9d0e1f2a

Authentication

Send your API key in the apikey request header.

Query Parameters

Parameter	Required	Description
`target`	Required	Domain name or IP address to scan. Example`deepinfo.com`
`timeout`	Optional	Scan timeout in seconds. Maximum and default: `85`. Example`85`
`proxy`	Optional	Optional proxy to scan through, in the form `scheme://user:password@host:port`.

Request Body

Parameter	Type	Description
`tcp_ports`	string	TCP ports to scan: a list (`"80,443"`), a range (`"440-445"`) or both. Omit to scan the default port set of `mode`
`udp_ports`	string	UDP ports to scan
`mode`	`light` \| `full`	Scan depth. Default `light`
`version`	boolean	Detect service versions. Default `false`
`os`	boolean	Detect the operating system. Default `false`
`scripts`	boolean	Run service detection scripts. Default `false`

application/json

{
  "tcp_ports": "80,443",
  "mode": "light",
  "version": true
}

Response Fields

Field	Description
`status`	`success`, or `host_down` if the host did not respond
`target`	The scanned host
`target_ip`	The IP address the host resolved to
`port_data.tcp[]`	One entry per TCP port in the result
`port_data.tcp[].port_number`	Port number
`port_data.tcp[].state`	Port state, e.g. `open`
`port_data.tcp[].service_name`	Name of the service, e.g. `https`
`port_data.tcp[].service_product`	Product that runs the service
`port_data.tcp[].service_version`	Version of that product
`port_data.tcp[].extra_data`	Additional data about the service
`port_data.udp[]`	One entry per UDP port in the result
`port_data.udp[].port_number`	Port number
`port_data.udp[].state`	Port state, e.g. `open`
`port_data.udp[].service_name`	Name of the service, e.g. `https`
`port_data.udp[].service_product`	Product that runs the service
`port_data.udp[].service_version`	Version of that product
`port_data.udp[].extra_data`	Additional data about the service
`os`	Operating system matches, when `os` is `true`
`check_date`	When the scan was performed (UTC)

Response Schema

Inferred from examples Built from the 2 saved 2xx example responses: the fields they contain, with the types seen there. It is not a contract.

Field	Type	Present	Example
`status`	string	2 of 2	`"success"`
`target`	string	2 of 2	`"deepinfo.com"`
`target_ip`	string	2 of 2	`"104.26.11.21"`
`check_date`	string	2 of 2	`"2026-09-22T16:06:23Z"`
`port_data`	object	2 of 2
`port_data.tcp`	array<object>	2 of 2
`port_data.tcp[].port_number`	number	2 of 2	`80`
`port_data.tcp[].service_name`	string	2 of 2	`"http"`
`port_data.tcp[].service_product`	null	2 of 2
`port_data.tcp[].service_version`	null	2 of 2
`port_data.tcp[].state`	string	2 of 2	`"open"`
`port_data.tcp[].extra_data`	object	2 of 2
`port_data.udp`	array	2 of 2
`os`	array	2 of 2

Errors

400 if target is missing or the body is invalid.

Examples

Saved examples from the Deepinfo API. Selecting one loads it into the request and response panels.

Reference updated September 27, 2026