1. IP Orders
Nstdata Resell Service API
  • Nstdata Resell API
    • Zones
      • Get service zone list
    • Channels
      • Get channel usage statistics
      • Get total usage for all service channels
      • Create channel
      • Batch query channels
      • Batch query channel usage summary
      • Get channel detail
      • Update channel
      • Delete channel
    • IP Products
      • Get service IP product list
    • IP Orders
      • Get total purchased IP quantity
        GET
      • Batch query IP orders
        POST
      • Buy service IPs
        POST
      • Get purchased IP order detail
        GET
      • Renew IP order
        POST
    • Regions
      • Get country list
    • Proxies
      • Generate proxies
    • Schemas
      • SuccessResponse
      • ErrorResponse
      • ProxyType
      • RegionProxyType
      • IpOrderType
      • ProxyProtocol
      • Zone
      • Channel
      • CreateChannelRequest
      • UpdateChannelRequest
      • ChannelIdsRequest
      • ChannelUsageRequest
      • ChannelStatistics
      • UsageMetric
      • ChannelUsageTotal
      • ChannelUsageSummary
      • IpProduct
      • PurchaseTotalByType
      • PurchaseTotal
      • OrderIdsRequest
      • IpProxyItem
      • IpOrder
      • IpOrderDetail
      • CreateIpOrderProduct
      • CreateIpOrderRequest
      • ErrorProxyItem
      • CreateIpOrderResponse
      • RenewSuccessItem
      • RenewIpOrderResponse
      • Country
      • GenerateProxiesResponse
  • Cloud Browser Developer API
    • Automation Access
      • Get CDP Credentials for an Existing Session
    • Session Configuration
      • Get Available Options
      • Estimate Browser Runtime Cost
    • Session Management
      • Create Browser Session
      • List Browser Sessions
      • Get Session Details and Status
      • Rename Browser Session
      • Stop Browser Session
    • Connection Credentials
      • Get Live View Credentials
    • Configuration Details
      • Get Session Configuration
    • Usage and Costs
      • Get Session Usage and Costs
      • Get Costs for Multiple Sessions
      • Get All Session Statistics
      • Get Historical Session Statistics
    • Schemas
      • BrowserConnectionResponseDto
      • BrowserOptionsResponseDto
      • BrowserErrorDto
      • SharedStorageErrorDto
      • SharedHttpErrorDto
      • BrowserEstimateDto
      • BrowserQuoteResponseDto
      • CreateBrowserDto
      • BrowserSessionResponseDto
      • BrowserListResponseDto
      • RenameBrowserDto
      • BrowserNameResponseDto
      • BrowserLiveViewResponseDto
      • BrowserConfigurationResponseDto
      • BrowserCostsResponseDto
      • BrowserCostsBatchDto
      • BrowserCostsBatchResponseDto
      • BrowserStatisticsResponseDto
      • BrowserHistoryStatisticsResponseDto
      • BrowserOptionsDto
      • BrowserQuoteDto
      • BrowserExtensionDto
      • BrowserCaptchaSettingsDto
      • BrowserFingerprintDto
      • BrowserSessionDto
      • BrowserListDto
      • BrowserNameDto
      • BrowserConnectionDto
      • BrowserLiveViewDto
      • BrowserConfigurationDto
      • BrowserCostsDto
      • BrowserCostsBatchDataDto
      • BrowserStatisticsDto
      • BrowserHistoryStatisticsDto
      • BrowserScreenOptionsDto
      • BrowserRecordingOptionsDto
      • BrowserFingerprintPresetDto
      • BrowserProxyCountryOptionDto
      • BrowserResourceClassOptionDto
      • BrowserCaptchaTypesDto
      • BrowserResolutionOptionDto
      • BrowserRecordingAvailabilityDto
      • BrowserProviderObservationDto
      • BrowserCaptchaPublicDto
      • BrowserEffectiveConfigurationDto
      • BrowserRequestedConfigurationDto
      • BrowserResolvedConfigurationDto
      • BrowserRuntimeCostDto
      • BrowserProxyCostDto
      • BrowserCaptchaCostDto
      • BrowserScreenRangeDto
      • BrowserNetworkIdentityDto
      • BrowserEffectiveExtensionDto
      • BrowserEffectiveFingerprintDto
      • BrowserConfigurationExtensionDto
      • BrowserResolvedFingerprintDto
      • BrowserIpAlignmentDto
  1. IP Orders

Batch query IP orders

POST
/api/v1/service/ip/query

Order status (data[].status)#

ValueNameMeaning
0IdleNot activated.
1ActivatedActivated. This is the only order status returned by this endpoint.
2ExpiredExpired; excluded from the batch response.
3DeletedSoft-deleted; excluded from the batch response.
Only activated orders owned by the current service and caller are returned. An input order ID missing from the response does not identify its exact status: it may be inactive, expired, deleted, nonexistent, or outside the authorized scope. Use GET /api/v1/service/purchase/ip/{orderId} to query a non-deleted order individually.
Check expireAt as well as status, because expiration status updates are asynchronous. These are order lifecycle values, not payment status or channel status values.

Response example provenance#

Examples were generated through local testing on 2026-09-15 using synthetic, nonfunctional test values for identifiers, proxy addresses and credentials. They illustrate the response format and are not production response captures. Amounts, stock and dates are illustrative, not live quotations or availability.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Success
Bodyapplication/json

🟠400BadRequestError
🟠401UnauthorizedError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/service/ip/query' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "orderIds": [
        "string"
    ]
}'
Response Response Example
200 - Batch order query — verified test data
Examples were generated through local testing on 2026-09-15 using synthetic, nonfunctional test values for identifiers, proxy addresses and credentials. They illustrate the response format and are not production response captures. Amounts, stock and dates are illustrative, not live quotations or availability. Request: POST /api/v1/service/ip/query with {"orderIds":["22222222-2222-4222-8222-222222222222"]}. data is an array. Batch responses preserve number; the individual order-detail endpoint uses quantity instead. This batch endpoint returns activated orders only.
{
    "data": [
        {
            "userId": "user_example_001",
            "ownerType": 0,
            "ownerId": "user_example_001",
            "createdBy": "user_example_001",
            "updatedBy": "user_example_001",
            "orderId": "22222222-2222-4222-8222-222222222222",
            "name": "Example ISP Order",
            "type": "ISP",
            "status": 1,
            "createdByServiceId": "service_example_001",
            "totalPrice": 6,
            "discount": 1,
            "period": 30,
            "expireAt": "2026-10-15T02:00:00.000Z",
            "createdAt": "2026-09-15T02:00:00.000Z",
            "updatedAt": "2026-09-15T02:00:00.000Z",
            "proxies": [
                {
                    "subOrderId": "11111111-1111-4111-8111-111111111111",
                    "productId": "product_example_us_001",
                    "basePrice": 3,
                    "region": "US",
                    "city": "New York",
                    "scene": "general",
                    "proxy": "192.0.2.10:8000:exampleuser:ExamplePass001",
                    "expireAt": "2026-10-15T02:00:00.000Z"
                },
                {
                    "subOrderId": "11111111-1111-4111-8111-111111111111",
                    "productId": "product_example_us_001",
                    "basePrice": 3,
                    "region": "US",
                    "city": "New York",
                    "scene": "general",
                    "proxy": "192.0.2.11:8000:exampleuser:ExamplePass001",
                    "expireAt": "2026-10-15T02:00:00.000Z"
                }
            ],
            "number": 2
        }
    ],
    "err": false,
    "msg": "SUCCESS",
    "code": 200
}
Modified at 2026-09-15 08:22:05
Previous
Get total purchased IP quantity
Next
Buy service IPs
Built with