3DSDB API Documentation

Version 1.0.2

Database Structure

The API serves content from a structured database located at public/db/3ds/

Categories

API Endpoints

Metadata Endpoints

Endpoints for retrieving title metadata and specific metadata fields.

GET /:tid

Retrieve title metadata in JSON format along with all available media URLs

Parameters:
tid - Title ID (16-character hexadecimal)
Response: JSON object containing title metadata and media URLs
GET /:tid/meta/:meta

Retrieve a specific metadata field

Parameters:
tid - Title ID (16-character hexadecimal)
meta - Metadata field name (e.g., name, description, release_date_on_eshop)
Response: Single metadata value

Media Asset Endpoints

Endpoints for accessing title banners, icons, and other media assets.

GET /:tid/banner

Get the title's banner image

Parameters:
tid - Title ID (16-character hexadecimal)
Response: JPEG image file
GET /:tid/icon

Get the title's icon image

Parameters:
tid - Title ID (16-character hexadecimal)
Response: JPEG image file

Screenshot Endpoints

Endpoints for accessing both compiled and uncompiled screenshots.

GET /:tid/screen/:num

Get a specific compiled screenshot

Parameters:
tid - Title ID (16-character hexadecimal)
num - Screenshot number
Response: JPEG image file
GET /:tid/screen_u

Get a list of all available uncompiled screenshots (upper and lower screens)

Parameters:
tid - Title ID (16-character hexadecimal)
Response: JSON object containing lists of upper and lower screen screenshots
GET /:tid/screen_u/:num/:screen

Get an uncompiled screenshot (upper/lower screen)

Parameters:
tid - Title ID (16-character hexadecimal)
num - Screenshot number
screen - Screen type (u for upper, l for lower)
Response: JPEG image file
GET /:tid/screens

Get a list of all available screenshots

Parameters:
tid - Title ID (16-character hexadecimal)
Response: JSON object containing screenshot URLs and count

Thumbnail Endpoints

Endpoints for accessing screenshot thumbnails.

GET /:tid/thumb/:num

Get a specific thumbnail

Parameters:
tid - Title ID (16-character hexadecimal)
num - Thumbnail number
Response: JPEG image file
GET /:tid/thumbs

Get a list of all available thumbnails

Parameters:
tid - Title ID (16-character hexadecimal)
Response: JSON object containing thumbnail URLs and count
GET /:tid/media

Get a comprehensive list of all available media for a title

Parameters:
tid - Title ID (16-character hexadecimal)
Response: JSON object containing all media URLs (banner, icon, screenshots, thumbnails)

System Information Endpoints

Endpoints for retrieving system-wide information and statistics.

GET /uptime

Get server uptime information

Response: JSON object containing server uptime in a human-readable format
GET /stats

Get statistics about titles in each category

Response: JSON object containing title counts per category and total
GET /category/:category

List all TIDs in a specific category

Parameters:
category - Category name (e.g., base, dlc, dsiware, etc.)
Response: JSON object containing category name, title count, and list of TIDs