LogoLogo
  • Documentation
  • Intergrations
  • Changelog
  • OVERVIEW
  • GETTING STARTED
    • Download 9Proxy
    • Quick Start
      • Configure Proxy on macOS/Windows
      • Configure Proxy on Linux
      • Use Proxies on Two or More Devices
    • Advanced Settings
      • For macOS/Windows
        • Set Up a Custom Port Range
        • Auto Rotation Proxy
        • Auto Refresh Proxy
        • Port Configuration
        • Sub-Accounts
        • Share Code / Use Code
        • Set Up a Non-Repeated Proxy
        • Bind IP to Port
      • For Linux
        • Sign In to 9Proxy Account
        • Command References
        • Set Up Starting Port & Port range
        • Auto Refresh Proxy
        • Proxy Authentication
        • Start API
  • API REFERENCES
    • Proxy API
    • Today List API
    • Port API
  • BILLING & PAYMENT
    • Cryptocurrency
    • 9Proxy Wallet
    • Local Payment
    • Credit Card
    • Google Pay
  • ACCOUNT MANAGEMENT
    • Account Deletion
  • TROUBLESHOOTING
    • IP Location Does Not Match
    • Speed Issues
On this page

Was this helpful?

  1. API REFERENCES

Port API

PreviousToday List APINextCryptocurrency

Last updated 2 months ago

Was this helpful?

Check port status

get

Returns the status of specified ports or all ports if 'ports=all' is provided.

Query parameters
tstringOptional

Response type 1=txt, 2=json

portsstringOptional

Specify a port number or use 'all' to check all ports.

Responses
200
Successful response
application/json
get
GET /api/port_check HTTP/1.1
Host: 
Accept: */*
200

Successful response

{
  "error": true,
  "message": "text",
  "data": [
    {
      "port": 1,
      "online": true
    }
  ]
}

Get port status

get

Returns the status of ports, including their address, city, public IP, and online status.

Query parameters
tstringOptional

Response type 1=txt, 2=json

Responses
200
Successful response
application/json
get
GET /api/port_status HTTP/1.1
Host: 
Accept: */*
200

Successful response

{
  "error": true,
  "message": "text",
  "data": [
    {
      "address": "text",
      "city": "text",
      "public_ip": "text",
      "online": true
    }
  ]
}

Set port range

get

Configures a range of ports starting from a specified port.

Query parameters
start_portstringOptional

The starting port of the range.

port_numstringOptional

The number of ports in the range.

tstringOptional

Response type 1=txt, 2=json

Responses
200
Successful response
application/json
406
Error response
application/json
get
GET /api/set_port_range HTTP/1.1
Host: 
Accept: */*
{
  "error": true,
  "message": "text"
}

Check free ports

get

Returns the status of requested ports.

Query parameters
portsstringOptional

List of ports to check, separated by commas.

tstringOptional

Response type 1=txt, 2=json

Responses
200
Successful response
application/json
get
GET /api/port_free HTTP/1.1
Host: 
Accept: */*
200

Successful response

{
  "error": true,
  "message": "text"
}
  • GETCheck port status
  • GETGet port status
  • GETSet port range
  • GETCheck free ports