Software

The NC State University Library Software API provides access to information about software available on library devices, including details on version, operating systems, and installation locations.

Endpoint

GET /api/software/everything.json

Base URL: https://www.lib.ncsu.edu/api/software/everything.json

Query Parameters

Parameter	Type	Description
keyword	string	Filter by software keyword
title	string	Filter by software title
category	string	Filter by software category (e.g., "Utilities") Full list (must be logged in)
building	string	Filter by library building (e.g., "hill", "hunt")
os	string	Filter by operating system (e.g., "Windows", "mac", "linux")
preinstalled	boolean	Filter for preinstalled software (true or false)

Response Format

The API returns an array of objects, where each object represents a software application with details about its availability and compatibility.

Example Response

[{
  "nid": "37110",
  "title": "7-Zip",
  "path": "/software/7-zip",
  "body": "
Use this software for archiving and compressing files.
",
  "preinstalled": true,
  "os": ["Windows"],
  "categories": [{"name": "Utilities", "tid": "36877"}],
  "devices": [
    {"nid": "52055", "title": "Windows Advanced Data Desktop"},
    {"nid": "60057", "title": "Alienware Aurora R12 Gaming Desktop"}
  ],
  "buildings": [
    {"nid": "22493", "name": "D. H. Hill Jr. Library", "shortened_name": "Hill Library"},
    {"nid": "22494", "name": "James B. Hunt Jr. Library", "shortened_name": "Hunt Library"}
  ]
}]

Response Fields

Field	Type	Description
nid	string	Unique identifier for the software.
title	string	Name of the software.
path	string	Relative URL to the software details.
body	string	HTML-formatted description of the software.
preinstalled	boolean	Indicates whether the software is preinstalled.
os	array[string]	Operating systems compatible with the software.
categories	array[object]	List of categories the software belongs to.
devices	array[object]	Library devices where the software is available.
buildings	array[object]	Library buildings where the software is accessible.

Usage Example

curl -X GET "https://www.lib.ncsu.edu/api/software/everything.json?os=Windows&category=Utilities" -H "Accept: application/json"

Support

For questions or issues related to this API, visit the Web Team.