Bitcall APIHLR API Reference
Every HLR endpoint, grouped by what it does. Requests go through the gateway and are authenticated with your key id and secret — see Authentication.
Products
Lookups
Returns your lookups, newest first, filterable by category, status and date range.
Queues one number or a batch for lookup and returns a lookup to poll. It is charged per number as results arrive.
Returns a lookup's status, per-outcome counts and price. Poll this after submitting.
Returns the per-number results of a lookup, paginated. Use an export for large completed lookups.
Stops a queued or running lookup. Numbers not yet processed are not charged. Repeating this is safe. This operation is safe to repeat: repeating it returns the existing state and performs no further action.
Exports
Starts building a downloadable file of a completed lookup's results. Repeating this returns the existing build. This operation is safe to repeat: repeating it returns the existing state and performs no further action.
Returns the export's state and, once ready, a time-limited download link.
Get a profile GET
Returns one eSIM profile: its status, and the activation code plus Apple one-tap link that install it. The activation code IS the QR payload — render it as a QR locally rather than expecting a hosted image. Treat it as a credential: it is never cached and never logged.
List products GET
Returns every lookup product available to you, each with the unit price that applies to your account.