Port Number LookupPort Number Lookup API

OnlineCredit Usage:1 per callRefreshed 3 weeks ago
avg: 231ms|p50: 219ms|p75: 239ms|p90: 264ms|p99: 314ms

Port Number Lookup is a tool for looking up well-known port numbers and network services. It provides information about ports including service name, protocol, description, and category for common network services.

The Port Number Lookup API provides reliable and fast access to port number lookup data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.

To use Port Number Lookup, you need an API key. You can get one by creating a free account and visiting your dashboard.

GET Endpoint

URL
https://api.apiverve.com/v1/portnumberlookup

Code Examples

Here are examples of how to call the Port Number Lookup API in different programming languages:

cURL Request
curl -X GET \
  "https://api.apiverve.com/v1/portnumberlookup?port=443" \
  -H "X-API-Key: your_api_key_here"
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/portnumberlookup?port=443', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.apiverve.com/v1/portnumberlookup?port=443', headers=headers)

data = response.json()
print(data)
Node.js (Native HTTPS)
const https = require('https');
const url = require('url');

const options = {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
};

const req = https.request('https://api.apiverve.com/v1/portnumberlookup?port=443', options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => console.log(JSON.parse(data)));
});

req.end();
PHP (cURL)
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/portnumberlookup?port=443');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: your_api_key_here',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

?>
Go (net/http)
package main

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

)

func main() {
    req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/portnumberlookup?port=443", nil)

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
Ruby (Net::HTTP)
require 'net/http'
require 'json'

uri = URI('https://api.apiverve.com/v1/portnumberlookup?port=443')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))
C# (HttpClient)
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key_here");

        var response = await client.GetAsync("https://api.apiverve.com/v1/portnumberlookup?port=443");
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Authentication

The Port Number Lookup API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Port Number Lookup API directly in your browser with live requests and responses.

Parameters

The Port Number Lookup API supports multiple query options. Use one of the following:

Option 1: Lookup by Port Number

ParameterTypeRequiredDescriptionDefaultExample
portintegerrequired
Port number to lookup
Range: 1 - 65535
-443

Option 2: Lookup by Service Name

ParameterTypeRequiredDescriptionDefaultExample
servicestringrequired
Service name to lookup
-https

Response

The Port Number Lookup API returns responses in JSON, XML, YAML, and CSV formats:

Example Responses

JSON Response
200 OK
{
  "status": "ok",
  "error": null,
  "data": {
    "port": 443,
    "service": "HTTPS",
    "protocol": "TCP",
    "description": "HTTP Secure (HTTP over TLS/SSL)",
    "category": "Web",
    "is_well_known": true,
    "is_registered": false,
    "is_dynamic": false
  }
}
XML Response
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <port>443</port>
    <service>HTTPS</service>
    <protocol>TCP</protocol>
    <description>HTTP Secure (HTTP over TLS/SSL)</description>
    <category>Web</category>
    <is_well_known>true</is_well_known>
    <is_registered>false</is_registered>
    <is_dynamic>false</is_dynamic>
  </data>
</response>
YAML Response
200 OK
status: ok
error: null
data:
  port: 443
  service: HTTPS
  protocol: TCP
  description: HTTP Secure (HTTP over TLS/SSL)
  category: Web
  is_well_known: true
  is_registered: false
  is_dynamic: false
CSV Response
200 OK
keyvalue
port443
serviceHTTPS
protocolTCP
descriptionHTTP Secure (HTTP over TLS/SSL)
categoryWeb
is_well_knowntrue
is_registeredfalse
is_dynamicfalse

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

FieldTypeSample ValueDescription
portnumber443-
servicestring"HTTPS"-
protocolstring"TCP"-
descriptionstring"HTTP Secure (HTTP over TLS/SSL)"-
categorystring"Web"-
is_well_knownbooleantrue-
is_registeredbooleanfalse-
is_dynamicbooleanfalse-

Headers

Required and optional headers for Port Number Lookup API requests:

Header NameRequiredExample ValueDescription
X-API-Keyrequiredyour_api_key_hereYour APIVerve API key. Found in your dashboard under API Keys.
Acceptoptionalapplication/jsonSpecify response format: application/json (default), application/xml, or application/yaml
User-AgentoptionalMyApp/1.0Identifies your application for analytics and debugging purposes
X-Request-IDoptionalreq_123456789Custom request identifier for tracking and debugging requests
Cache-Controloptionalno-cacheControl caching behavior for the request and response

Learn more about request headers →

GraphQL AccessALPHA

Access Port Number Lookup through GraphQL to combine it with other API calls in a single request. Query only the port number lookup data you need with precise field selection, and orchestrate complex data fetching workflows.

Test Port Number Lookup in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  portnumberlookup(
    input: {
      port: 443
    }
  ) {
    port
    service
    protocol
    description
    category
    is_well_known
    is_registered
    is_dynamic
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Port Number Lookup API supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call Port Number Lookup directly from browser-based applications without proxy servers.

CORS HeaderValueDescription
Access-Control-Allow-Origin*Accepts requests from any origin
Access-Control-Allow-Methods*Accepts any HTTP method
Access-Control-Allow-Headers*Accepts any request headers

Browser Usage: You can call Port Number Lookup directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.

Learn more about CORS support →

Rate Limiting

Port Number Lookup API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all Port Number Lookup users.

PlanRate LimitDescription
Free5 requests/minHard rate limit enforced - exceeding will return 429 errors
StarterNo LimitProduction ready - standard traffic priority
ProNo LimitProduction ready - preferred traffic priority
MegaNo LimitProduction ready - highest traffic priority

Learn more about rate limiting →

Rate Limit Headers

When rate limits apply, each Port Number Lookup response includes headers to help you track your usage:

HeaderDescription
X-RateLimit-LimitMaximum number of requests allowed per time window
X-RateLimit-RemainingNumber of requests remaining in the current window
X-RateLimit-ResetUnix timestamp when the rate limit window resets

Handling Rate Limits

Free Plan: When you exceed your rate limit, Port Number Lookup returns a 429 Too Many Requests status code. Your application should implement appropriate backoff logic to handle this gracefully.

Paid Plans: No rate limiting or throttling applied. All paid plans (Starter, Pro, Mega) are production-ready.

Best Practices for Port Number Lookup:

  • Monitor the rate limit headers to track your Port Number Lookup usage (Free plan only)
  • Cache port number lookup responses where appropriate to reduce API calls
  • Upgrade to Pro or Mega for guaranteed no-throttle Port Number Lookup performance

Note: Port Number Lookup rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using Port Number Lookup on Free tier.

Error Codes

The Port Number Lookup API uses standard HTTP status codes to indicate success or failure:

CodeMessageDescriptionSolution
200OKRequest successful, data returnedNo action needed - request was successful
400Bad RequestInvalid request parameters or malformed requestCheck required parameters and ensure values match expected formats
401UnauthorizedMissing or invalid API keyInclude x-api-key header with valid API key from dashboard
403ForbiddenAPI key lacks permission or insufficient creditsCheck credit balance in dashboard or upgrade plan
429Too Many RequestsRate limit exceeded (Free: 5 req/min)Implement request throttling or upgrade to paid plan
500Internal Server ErrorServer error occurredRetry request after a few seconds, contact support if persists
503Service UnavailableAPI temporarily unavailableWait and retry, check status page for maintenance updates

Learn more about error handling →

Need help? Contact support with your X-Request-ID for assistance.

Integrate Port Number Lookup with SDKs

Get started quickly with official Port Number Lookup SDKs for your preferred language. Each library handles authentication, request formatting, and error handling automatically.

Available for Node.js, Python, C#/.NET, and Android/Java. All SDKs are open source and regularly updated.

Integrate Port Number Lookup with No-Code API Tools

Connect the Port Number Lookup API to your favorite automation platform without writing code. Build workflows that leverage port number lookup data across thousands of apps.

All platforms use your same API key to access Port Number Lookup. Visit our integrations hub for step-by-step setup guides.

Frequently Asked Questions

How do I get an API key for Port Number Lookup?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Port Number Lookup and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does Port Number Lookup cost?

Each successful Port Number Lookup API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful port number lookup lookups.

Can I use Port Number Lookup in production?

The free plan is for testing and development only. For production use of Port Number Lookup, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use Port Number Lookup from a browser?
Yes! The Port Number Lookup API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
What happens if I exceed my Port Number Lookup credit limit?

When you reach your monthly credit limit, Port Number Lookup API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?