REST API Documentation

This document describes the REST API available for interacting with GTA Tunes. The API is read-only and does not require authentication.

I highly recommend looking at the referenced TS API types.

API Endpoints

• Stations - /api/stations
  • Game Stations - /api/stations/:game
  • Game Station - /api/stations/:game/:station
  • Play Song - /api/stations/:game/:station/play
• GTA SA Segments
  • Advertisements - /api/segments/sa
  • Play Advertisement - /api/segments/sa/play
  • Play Station Segment - /api/segments/sa/:station/play
• Github Versions - /api/github/versions

Support Games

The following games are currently supported in the API:

• GTA III
• GTA Vice City
• GTA San Andreas

Stations

Get all of the stations for all games.

Route

/api/stations

Query Parameters

Name	Type	Description	Required	Default
with_songs	1 or 0	Whether to include stations with songs.	No	0
with_segments	1 or 0	Whether to include segments in the station (GTA SA only).	No	0

Response

Api.Stations;

Game Stations

Get all of the stations for a specific game.

Route

/api/stations/:game

Game types

Game Name	Key	Endpoint
GTA III	iii	/api/stations/iii
GTA Vice City	vc	/api/stations/vc
GTA San Andreas	sa	/api/stations/sa

Query Parameters

Name	Type	Description	Required	Default
with_songs	1 or 0	Whether to include stations with songs.	No	1
with_segments	1 or 0	Whether to include segments in the station (GTA SA only).	No	0

Response

Api.Station[];

Game Station

Get a specific music station for a game.

Route

/api/stations/:game/:station

Station types

GTA III Station Keys

Station Name	Key	Endpoint
Flashback FM	flashback_fm	/api/stations/iii/flashback_fm
Head Radio	head_radio	/api/stations/iii/head_radio
Double Clef FM	double_clef_fm	/api/stations/iii/double_clef_fm
K-JAH Radio	k_jah	/api/stations/iii/k_jah
Rise FM	rise_fm	/api/stations/iii/rise_fm
MSX FM	msx_fm	/api/stations/iii/msx_fm
Lips 106	lips_106	/api/stations/iii/lips_106
Game Radio FM	game_radio_fm	/api/stations/iii/game_radio_fm

GTA Vice City Station Keys

Station Name	Key	Endpoint
Wildstyle	wildstyle	/api/stations/vc/wildstyle
Flash FM	flash_fm	/api/stations/vc/flash_fm
Fever 105	fever_105	/api/stations/vc/fever_105
V-Rock	v_rock	/api/stations/vc/v_rock
Espantoso	espantoso	/api/stations/vc/espantoso
Emotion 98.3	emotion	/api/stations/vc/emotion
Wave 103	wave	/api/stations/vc/wave

GTA San Andreas Station Keys

Station Name	Key	Endpoint
Bounce FM	bounce_fm	/api/stations/sa/bounce_fm
CSR 103.9	csr	/api/stations/sa/csr
K-DST	k_dst	/api/stations/sa/k_dst
K-JAH West	k_jah	/api/stations/sa/k_jah
K-Rose	k_rose	/api/stations/sa/k_rose
Master Sounds 98.3	master_sounds	/api/stations/sa/master_sounds
Playback FM	playback_fm	/api/stations/sa/playback_fm
Radio X	radio_x	/api/stations/sa/radio_x
SF-UR	sfur	/api/stations/sa/sfur
Radio Los Santos	radio_los_santos	/api/stations/sa/radio_los_santos
WCTR	wctr	/api/stations/sa/wctr

Query Parameters

Name	Type	Description	Required	Default
with_songs	1 or 0	Whether to include songs in the station.	No	1
with_segments	1 or 0	Whether to include segments in the station (GTA SA only).	No	0

Response

Api.Station;

Play Song

Play a specific song from a station.

Route

/api/stations/:game/:station/play

Query Parameters

Name	Description	Required	Default
song	The name of the song to play	Yes	N/A

San Andreas Specific Query Parameters

Name	Description	Required	Default
intro	The intro index to play	No	0
outro	The outro index to play	No	0

Response

An mp3 audio file.

GTA SA Segments

Advertisements

Get all gta sa advertisements.

Route

/api/segments/sa

Response

Api.Segment[];

Play Advertisement

Play a specific gta sa advertisement.

Route

/api/segments/sa/play

Query Parameters

Name	Description	Required	Default
advert	The name of the advertisement to play	Yes	N/A

Response

An mp3 audio file.

Play Station Segment

Route

/api/segments/sa/:station/play

Query Parameters

Name	Description	Required	Default
station_jingle	Play a station jingle segment	No	N/A
caller	Play a caller segment	No	N/A
weather	Play a weather segment	No	N/A
bridge_announcement	Play a bridge announcement segment	No	N/A
dj_talk	Play a DJ talk segment	No	N/A
story	Play a story segment	No	N/A

One of the above parameters is required.

Response

An mp3 audio file.

Github

Github Versions

Get all of the GTATunes github versions.

Route

/api/github/versions

Response

Api.Github.Version[];