Skip to main content
GET
Search Product

Authorizations

X-API-Private-Key
string
header
required

Private API key for user-level authentication.

X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Query Parameters

product_id
string

Unique identifier of the Product

product_type
enum<string>

Type associated with the Product

Available options:
credit,
datacenter,
isp,
residential,
mobile
product_protocol
enum<string>

Protocol associated with the Product

Available options:
ipv4,
ipv6,
dual
country_id
string

Country ID for the region of the product

product_is_active
boolean

Whether the Product is active

product_is_one_per_customer
boolean

Whether the Product is one per customer

product_is_one_active_per_customer
boolean

Whether the Product is one active per customer

product_is_per_ip
boolean

Whether the Product is one per IP

per_page
integer

Number of items per page for pagination

page
integer

Page number for pagination

sort_by
string

Key for sorting or random.

Response

200 - application/json

Product search with stock successfully retrieved.

data
object[]
item_count
integer
Example:

1

message
string
Example:

"Product search with stock successfully completed."

page
integer
Example:

1

per_page
integer
Example:

100

total_count
integer
Example:

1