Response schema

Objects returned by the five customer endpoints, generated from the schemas the API validates against.

Conventions

slug is a lowercase, hyphen-separated identifier such as samsung-galaxy-f08-gsma-14988.
string (datetime) values are ISO 8601 timestamps in UTC.
category is one of phone, tablet, smartwatch, laptop, desktop, cpu, gpu, motherboard, memory, storage, peripheral, reference. The catalog currently has data for phone, tablet, and smartwatch; the other values are reserved.
Optional fields are left out of the response when the value is unknown.

DeviceDetail

Returned as data by GET /v1/devices/:slug. specs holds the spec groups listed below.

DeviceDetail fields
Field	Type	Presence
`id`	`string (uuid)`	Required
`slug`	`slug`	Required
`name`	`string`	Required
`brand`	`Brand`	Required
`brandSlug`	`slug`	Required
`category`	`category`	Required
`summary`	`string`	Required
`specs`	`object`	Required
`variants`	`Variant[]`	Required
`releasedAt`	`string (datetime)`	Optional
`updatedAt`	`string (datetime)`	Required
`revision`	`string`	Required

Brand

Embedded in DeviceDetail and returned as list items by GET /v1/brands.

Brand fields
Field	Type	Presence
`id`	`string (uuid)`	Required
`slug`	`slug`	Required
`name`	`string`	Required
`deviceCount`	`integer`	Optional

Variant

One SKU or memory configuration of a device, with variant-level specs.

Variant fields
Field	Type	Presence
`id`	`string (uuid)`	Required
`slug`	`slug`	Required
`name`	`string`	Required
`specs`	`object`	Required

CustomerDeviceMatch

The identifier-only list item returned by GET /v1/search. It does not contain summaries, specifications, images, totals or revision data.

CustomerDeviceMatch fields
Field	Type	Presence
`id`	`string (uuid)`	Required
`slug`	`slug`	Required
`name`	`string`	Required
`brand`	`string`	Required
`brandSlug`	`slug`	Required
`category`	`category`	Required

Revision

Top-level revision on brands, categories and compare responses. Search does not include this object; DeviceDetail has a revision string inside data.

Revision fields
Field	Type	Presence
`revision`	`string`	Required
`updatedAt`	`string (datetime)`	Required

Error

Body of customer API error responses.

Error fields
Field	Type	Presence
`error`	`object`	Required
`error.code`	`string`	Required
`error.message`	`string`	Required

Spec groups

specs (and each variant's specs) is an object keyed by spec group. Groups and fields appear only when the source states a value, so treat every field as optional. specs.image_url holds an HTTPS product image URL when one is available.

battery.charging can include wired_w, wireless_w, reverse_w, methods, protocols, times, and rates.

`specs.launch` · Launch

Announcement and availability.

specs.launch fields
Field	Type	Presence
`launch.announced_on`	`string \| null`	Optional
`launch.released_on`	`string`	Optional
`launch.availability`	`string`	Optional
`launch.date_precision`	`string`	Optional

`specs.body` · Body

Dimensions, weight, materials, SIM and ingress protection.

specs.body fields
Field	Type	Presence
`body.dimensions`	`object`	Optional
`body.weight`	`object`	Optional
`body.materials`	`object`	Optional
`body.material_details`	`object[]`	Optional
`body.sim`	`string`	Optional
`body.sim_variants`	`object[]`	Optional
`body.water_resistance`	`string \| null`	Optional
`body.water_resistant`	`boolean`	Optional
`body.water_resistance_atm`	`number`	Optional
`body.water_resistance_depth_m`	`number`	Optional
`body.dust_resistance`	`string`	Optional
`body.immersion`	`object`	Optional
`body.stylus_support`	`boolean`	Optional
`body.additional_notes`	`string[]`	Optional

`specs.display` · Display

Panel, size, resolution, refresh rate and brightness.

specs.display fields
Field	Type	Presence
`display.panel_type`	`string`	Optional
`display.size_inches`	`number`	Optional
`display.resolution`	`object`	Optional
`display.screen_to_body_ratio_percent`	`number`	Optional
`display.refresh_rate_hz`	`number`	Optional
`display.pwm_hz`	`number`	Optional
`display.peak_brightness_nits`	`number`	Optional
`display.typical_brightness_nits`	`number`	Optional
`display.hbm_brightness_nits`	`number`	Optional
`display.brightness_nits`	`number`	Optional
`display.color_depth`	`string`	Optional
`display.hdr`	`string[]`	Optional
`display.protection`	`string \| null`	Optional
`display.additional_features`	`string[]`	Optional
`display.additional_notes`	`string[]`	Optional

`specs.platform` · Platform

Operating system, chipset, CPU and GPU.

specs.platform fields
Field	Type	Presence
`platform.os`	`string`	Optional
`platform.chipset`	`object`	Optional
`platform.cpu`	`string \| null`	Optional
`platform.cpu_short`	`string`	Optional
`platform.gpu`	`string \| null`	Optional

`specs.memory` · Memory

Storage and RAM configurations and card slot.

specs.memory fields
Field	Type	Presence
`memory.variants`	`object[]`	Optional
`memory.storage_type`	`string \| null`	Optional
`memory.card_slot`	`boolean \| null`	Optional
`memory.card_slot_description`	`string`	Optional

`specs.cameras` · Cameras

Main (rear) and selfie camera modules.

specs.cameras fields
Field	Type	Presence
`cameras.main`	`object`	Optional
`cameras.selfie`	`object`	Optional

`specs.audio` · Audio

Speakers and headphone jack.

specs.audio fields
Field	Type	Presence
`audio.loudspeaker`	`boolean`	Optional
`audio.headphone_jack`	`boolean \| null`	Optional
`audio.description`	`string`	Optional
`audio.additional_notes`	`string[]`	Optional

`specs.connectivity` · Connectivity

Wi-Fi, Bluetooth, positioning, NFC, USB and radio.

specs.connectivity fields
Field	Type	Presence
`connectivity.wlan`	`string \| null`	Optional
`connectivity.bluetooth`	`string`	Optional
`connectivity.positioning`	`string[]`	Optional
`connectivity.nfc`	`string \| null`	Optional
`connectivity.usb`	`string \| null`	Optional
`connectivity.radio`	`boolean \| null`	Optional
`connectivity.radio_description`	`string`	Optional
`connectivity.infrared`	`boolean`	Optional

`specs.network` · Network

Cellular technologies, bands and speeds.

specs.network fields
Field	Type	Presence
`network.technologies`	`string[]`	Optional
`network.bands_2g`	`string[]`	Optional
`network.bands_3g`	`string[]`	Optional
`network.bands_4g`	`string[]`	Optional
`network.bands_5g`	`string[]`	Optional
`network.speed`	`string[]`	Optional
`network.speed_tier`	`number`	Optional
`network.speed_highest`	`string`	Optional
`network.speed_highest_label`	`string`	Optional

`specs.battery` · Battery

Capacity and charging.

specs.battery fields
Field	Type	Presence
`battery.capacity_mah`	`number \| null`	Optional
`battery.type`	`string`	Optional
`battery.charging`	`object`	Optional
`battery.additional_notes`	`string[]`	Optional

`specs.features` · Features

Sensors and other features.

specs.features fields
Field	Type	Presence
`features.sensors`	`string[]`	Optional
`features.additional_notes`	`string[]`	Optional

`specs.misc` · Misc

Colors, model numbers and SAR values.

specs.misc fields
Field	Type	Presence
`misc.colors`	`string[]`	Optional
`misc.model_numbers`	`string[]`	Optional
`misc.sar_eu`	`object`	Optional
`misc.sar_us`	`object`	Optional
`misc.eu_label`	`object`	Optional

Conventions

DeviceDetail

Brand

Variant

CustomerDeviceMatch

Revision

Error

Spec groups

specs.launch · Launch

specs.body · Body

specs.display · Display

specs.platform · Platform

specs.memory · Memory

specs.cameras · Cameras

specs.audio · Audio

specs.connectivity · Connectivity

specs.network · Network

specs.battery · Battery

specs.features · Features

specs.misc · Misc