API reference

Markets

Market-wide rate indices across destinations.

3 operationsBase URL https://packetexchange.io/api/v1Postman collection

Get the marketplace summary

GET/api/v1/markets/summary

Access: Key optional. A key or token personalises the answer.
Rate limit: 100 requests per second (the default)

Public counts for everyone; capacity, ASR, ACD and average price only for signed-in callers.

Response 200

Field	Type	Description
`data`required	object	-
`routes`requireddata.routes	integer	-
`destinations`requireddata.destinations	integer	-
`voiceRoutes`requireddata.voiceRoutes	integer	-
`smsRoutes`requireddata.smsRoutes	integer	-
`hasRoutes`requireddata.hasRoutes	boolean	-
`hasActivityData`requireddata.hasActivityData	boolean	-
`capacity`data.capacity	integer	-
`avgAsr`data.avgAsr	number \| null	-
`measuredAsr`data.measuredAsr	number \| null	-
`measuredAsrSample`data.measuredAsrSample	integer	-
`avgAcd`data.avgAcd	number \| null	-
`avgPrice`data.avgPrice	number \| null	Display figure
`topMovers`requireddata.topMovers	any[]	-
`marketStatus`requireddata.marketStatus	string	-
`asOf`requireddata.asOf	string (date-time)	Start of the 24h activity window

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List destinations with live routes and their lowest rates

GET/api/v1/pricing/destinations

Access: Public. No key needed.
Rate limit: 100 requests per second (the default)

Public. Every destination with at least one live, buyer-visible route, per product: slug, route count and lowest rate. Pass type for one product; without it both voice and sms lists are returned. Rebuilt at most every 10 minutes (Cache-Control: public, max-age=600). Rates are the sellers' list prices before the platform fee.

Parameters

Name	In	Type	Description
`type`	query	string	-One of voice, sms

Response 200

Field	Type	Description
`data`required	object	-
`voice`data.voice	object[]	-
`slug`requireddata.voice[].slug	string	URL slug from the country name, e.g. "pakistan"
`country`requireddata.voice[].country	string	-
`countryCode`requireddata.voice[].countryCode	string	E.164 country calling code, digits only
`routes`requireddata.voice[].routes	integer	Live routes that price at least one number type
`lowest`requireddata.voice[].lowest	string	Lowest mobile, fixed or country-wide rate
`lowestBand`requireddata.voice[].lowestBand	string	`mobile` and `fixed`: rate-sheet rows named for that number type. `countryWide`: the bare country row (or a single-price listing), which prices every number without a more specific row.One of `mobile`, `fixed`, `countryWide`
`unit`requireddata.voice[].unit	string	Per minute (voice) or per message (SMS)One of `min`, `msg`
`sms`data.sms	object[]	Same fields as PricingDestination, shown earlier on this page.
`updatedAt`requireddata.updatedAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get the live market for one destination

GET/api/v1/pricing/destinations/{slug}

Access: Public. No key needed.
Rate limit: 100 requests per second (the default)

Public. Lowest rate per number type, mobile operator breakouts, caller-ID and billing-increment mix, and the five cheapest routes as anonymous facts (price, caller ID, increment, stated ASR). The ASR here is the one the seller states; measured figures per listing are on GET /routes (measured). 404 when the destination has no live route of that type. Cached like the list.

Parameters

Name	In	Type	Description
`slug`required	path	string	-
`type`	query	string	-One of voice, smsDefault "voice"

Response 200

Field	Type	Description
`data`required	object	-
`slug`requireddata.slug	string	URL slug from the country name, e.g. "pakistan"
`country`requireddata.country	string	-
`countryCode`requireddata.countryCode	string	E.164 country calling code, digits only
`routes`requireddata.routes	integer	Live routes that price at least one number type
`lowest`requireddata.lowest	string	Lowest mobile, fixed or country-wide rate
`lowestBand`requireddata.lowestBand	string	`mobile` and `fixed`: rate-sheet rows named for that number type. `countryWide`: the bare country row (or a single-price listing), which prices every number without a more specific row.One of `mobile`, `fixed`, `countryWide`
`unit`requireddata.unit	string	Per minute (voice) or per message (SMS)One of `min`, `msg`
`type`requireddata.type	string	-One of `voice`, `sms`
`highest`requireddata.highest	string	Highest route "from" price in the destination
`bands`requireddata.bands	object[]	Lowest rate per number type
`key`requireddata.bands[].key	string	`mobile` and `fixed`: rate-sheet rows named for that number type. `countryWide`: the bare country row (or a single-price listing), which prices every number without a more specific row.One of `mobile`, `fixed`, `countryWide`
`from`requireddata.bands[].from	string	USD, 6-decimal string, e.g. "0.020370"
`routes`requireddata.bands[].routes	integer	-
`operators`requireddata.operators	object[]	Mobile operators broken out on at least two routes, cheapest first, at most 12
`name`requireddata.operators[].name	string	-
`from`requireddata.operators[].from	string	USD, 6-decimal string, e.g. "0.020370"
`routes`requireddata.operators[].routes	integer	-
`cliTypes`requireddata.cliTypes	object[]	Caller-ID handling the sellers state (voice only)
`cliType`requireddata.cliTypes[].cliType	string	-
`routes`requireddata.cliTypes[].routes	integer	-
`increments`requireddata.increments	object[]	Billing increments, e.g. "1/1" (voice only)
`increment`requireddata.increments[].increment	string	-
`routes`requireddata.increments[].routes	integer	-
`routesWithStatedAsr`requireddata.routesWithStatedAsr	integer	Routes whose seller states an ASR
`otherBreakouts`requireddata.otherBreakouts	integer	Named breakouts that are not a headline number type (toll-free, premium, cities)
`topRoutes`requireddata.topRoutes	object[]	The five cheapest routes, as anonymous facts
`rank`requireddata.topRoutes[].rank	integer	-
`from`requireddata.topRoutes[].from	string	USD, 6-decimal string, e.g. "0.020370"
`mobileFrom`requireddata.topRoutes[].mobileFrom	string \| null	USD, 6-decimal string, e.g. "0.020370"
`cliType`requireddata.topRoutes[].cliType	string	-
`billingIncrement`requireddata.topRoutes[].billingIncrement	string \| null	-
`routeType`requireddata.topRoutes[].routeType	string	Quality tier the route is listed under
`statedAsr`requireddata.topRoutes[].statedAsr	string \| null	Seller-stated ASR %, not measured
`statedAcd`requireddata.topRoutes[].statedAcd	string \| null	Seller-stated ACD in seconds, not measured
`related`requireddata.related	object[]	Destinations in the same world numbering zoneSame fields as PricingDestination, shown earlier on this page.
`updatedAt`requireddata.updatedAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.