Skip to content

Latest commit

 

History

History
271 lines (219 loc) · 17.6 KB

API.md

File metadata and controls

271 lines (219 loc) · 17.6 KB
Raw

API

Note All parts have a price property corresponding to the part's price (in USD).

cpu

Property Description Unit (if applicable)
core_count Number of cores
core_clock Core clock GHz
boost_clock Boost clock GHz
tdp TDP W
graphics Integrated graphics, if any
smt SMT support

cpu-cooler

Property Description Unit (if applicable)
rpm Fan RPM RPM
noise_level Noise level. May be a range. In which case, its type is [number, number] instead, corresponding to min and max dB respectively dB
color Color
size Radiator size mm

motherboard

Property Description Unit (if applicable)
socket Socket
form_factor Form factor
max_memory Maximum memory GB
memory_slots Number of memory slots
color Color

memory

Property Description Unit (if applicable)
speed [number, number] corresponding to the DDR version and RAM speed, respectively MHz ([1])
modules [number, number] corresponding to the number of modules and the size of each module, respectively GB ([1])
price_per_gb Price / GB USD
color Color
first_word_latency First Word Latency ns
cas_latency CAS Latency

internal-hard-drive

Property Description Unit (if applicable)
capacity Capacity GB
price_per_gb Price / GB USD
type SSD if the drive is an SSD, otherwise the speed of the HDD RPM if it is an HDD
cache Cache MB
form_factor M.2-xxxx if the drive is an M.2, otherwise the size (in inches) of the HDD inches if it is an HDD
interface PCIe/SATA interface information

video-card

Property Description Unit (if applicable)
chipset Chipset
memory Memory GB
core_clock Core clock MHz
boost_clock Boost clock MHz
color Color
length Length mm

case

Property Description Unit (if applicable)
type Type (ATX/mATX/etc.)
color Color
psu Wattage of included power supply, if any W
side_panel Side panel material information
external_volume External volume L
internal_35_bays Number of internal 3.5" bays

power-supply

Property Description Unit (if applicable)
type Type (ATX/SFX/etc.)
efficiency Efficiency rating (plus/bronze/silver/etc.)
wattage Wattage W
modular Modularity (Full/Semi/false)
color Color

os

Property Description Unit (if applicable)
mode number or [number, number] corresponding to either 32-bit, 64-bit, or both
max_memory Maximum memory

monitor

Property Description Unit (if applicable)
screen_size Screen size (length of diagonal) in
resolution [number, number] corresponding to width and height, respectively pixels
refresh_rate Refresh rate Hz
response_time Response time ms
panel_type Panel type (IPS/TN/etc.)
aspect_ratio Aspect ratio (e.g. 16:9)

sound-card

Property Description Unit (if applicable)
channels Channels
digital_audio Digital audio units (64, 32, 24, etc.)
snr SNR (signal-to-noise ratio) dB
sample_rate Sample rate kHz
chipset Chipset
interface Interface (e.g. PCI/PCIe x1)

wired-network-card

Property Description Unit (if applicable)
interface Interface (e.g. PCIe x8/x4/x1)
color Color

wireless-network-card

Property Description Unit (if applicable)
protocol Protocol (e.g. Wi-Fi 6E/6/5)
interface Interface (e.g. PCIe x8/x4/x1)
color Color

headphones

Property Description Unit (if applicable)
type Type (e.g. Circumaural/Earbud/etc.)
frequency_response [number, number] corresponding to the frequency response range (min and max, respectively) kHz
microphone Whether it has a microphone
wireless Whether it is wireless
enclosure_type Enclosure type (e.g. Closed/Open)
color Color

keyboard

Property Description Unit (if applicable)
style Style (e.g. Gaming/Mini)
switches Type of switches (e.g. Cherry Viola/Logitech GL)
backlit Backlit color (e.g. RGB/multicolor/solid color)
tenkeyless Whether it is tenkeyless
connection_type Connection type (Wired, Wireless, or multiple)
color Color

mouse

Property Description Unit (if applicable)
tracking_method Tracking method (e.g. Optical/Laser)
connection_type Connection type (Wired, Wireless, or multiple)
max_dpi Maximum DPI dpi
hand_orientation Hand orientation (Left/Right/Both)
color Color

speakers

Property Description Unit (if applicable)
configuration Channel configuration
wattage Wattage W
frequency_response [number, number] corresponding to the lower and upper frequency responses, respectively kHz
color Color

webcam

Property Description Unit (if applicable)
resolutions List of supported resolution (e.g. ["4k", "1080p", "720p"])
connection Type of connection
focus_type Focus type (Auto/Manual/Fixed)
os List of supported operating systems (e.g. ["Windows", "OS X"])
fov FOV angle degrees (°)

case-accessory

Property Description Unit (if applicable)
type Type (LED Controller/Card Reader)
form_factor Form factor (e.g. 2.5). May be a [number, number], in which case [0] is the quantity and [1] is the size in ([1] if array)

case-fan

Property Description Unit (if applicable)
size Size mm
color Color
rpm number or [number, number] corresponding to the lower and upper RPM values, respectively RPM
airflow number or [number, number] corresponding to the lower and upper airflow CFM values, respectively CFM
noise_level number or [number, number] corresponding to the lower and upper noise level values, respectively dB
pwm Whether it is PWM

fan-controller

Property Description Unit (if applicable)
channels Number of channels
channel_wattage Channel wattage W
pwm Whether it is PWM
form_factor Form factor (e.g. 5.25) in
color Color

thermal-paste

Property Description Unit (if applicable)
amount Amount g

external-hard-drive

Property Description Unit (if applicable)
type Type (Desktop/Portable)
interface Interface
capacity Capacity GB
price_per_gb Price / GB USD
color Color

optical-drive

Property Description Unit (if applicable)
bd BD read speed
dvd DVD read speed
cd CD read speed
bd_write BD write timings (e.g. 14/12/2/2)
dvd_write DVD write timings (e.g. 16/8/8/6/12/8/5)
cd_write CD write timings (e.g. 48/32)

ups

Property Description Unit (if applicable)
capacity_w Capacity W
capacity_va Capacity (volt-amperes) VA