How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Soracom Query API

Search SIMs, Soracom Inventory devices, and Sigfox devices

Soracom Query API is one of 45 APIs that Soracom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Query. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 20250903-043502.

Requests are made against 2 base URLs: https://api.soracom.io/v1, https://g.api.soracom.io/v1.

5 operations 5 paths 19 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20250903-043502
Base URL
https://api.soracom.io/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Soracom Query API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Soracom-API-Key (api_key). An API key is passed in the header as X-Soracom-Token (api_token).

  • api_key — API key for authentication. Obtain this from the Soracom User Console or via the Auth API. Required in combination with an API token for all authenticated requ…
  • api_token — API token for authentication. This token has an expiration time and must be refreshed periodically. Required in combination with an API key for all authenticat…

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Query 5

Search SIMs, Soracom Inventory devices, and Sigfox devices

GET
/query/devices
Search Soracom Inventory devices by query
searchDevices 10 params → 200400
GET
/query/sigfox_devices
Search Sigfox devices by query
searchSigfoxDevices 10 params → 200400
GET
/query/sims
Search SIMs by query terms
searchSims 17 params → 200400
GET
/query/subscribersdeprecated
(DEPRECATED) Search subscribers by query terms
searchSubscribers 12 params → 200400
GET
/query/subscribers/traffic_volume/ranking
Search traffic volume ranking of subscribers
searchSubscriberTrafficVolumeRanking 4 params → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Subscriber (33 properties), Sim (28 properties), Device (16 properties), SessionStatus (14 properties). Each schema is shown below with its type and property counts.

Placement
object
2 properties
ArcSessionStatus
object
10 properties
TagSet
object
An object which always contains at least one property "name" with a string value. If you give a subscriber/SIM a name, the name will be returned as the value o…
Device
object
16 properties
ImeiLock
object
IMEI lock configuration.
1 property
LastSeen
object
3 properties
Map
object
LocationRegistrationStatusForNetwork
object
2 properties
SimProfile
object
6 properties
Capabilities
object
2 properties
PreviousSessionStatus
object
Information about the previous session.
12 properties
SigfoxDevice
object
8 properties
Sim
object
28 properties
LocationRegistrationStatus
object
3 properties
SimplifiedSubscriber
object
6 properties
Subscriber
object
33 properties
Cell
object
Information about the base station to which the IoT SIM is connected. It will not be output for virtual SIM/subscribers.
9 properties
TrafficVolumeRanking
object
2 properties
SessionStatus
object
Information about the current session.
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-query-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom SIM Management API
Soracom Group Configuration API
Soracom Billing API
Soracom Stats and Diagnostics API
Soracom Auth and Access Management API
Soracom Lagoon API
Soracom Cloud Camera Services API
Soracom Batch API
Soracom Analysis API
Soracom API Sandbox: Coupon API
Soracom API Sandbox: Operator API
Soracom API Sandbox: Order API
Where this information came from

This is an independent, third-party profile of Soracom Query API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.