Launch Library Reading API Overview

Calls

  • All API calls should be made with HTTP POST.
  • Request data is passed by POSTing JSON objects to the endpoints listed below


Returns


All returns are JSON objects with various options. The data on non-failure will be variable depending on your options. Failures will contain a status variable and a msg variable:

Failure

Name Description
status "fail"
msg A probably should be more helpful error message.


Agency

Usage: https://launchlibrary.net/1.0/agency/get

Example message:


		{
	   		"mode" : "list"
		}
		
Name Description
mode How much you want returned. Either list, summary, or verbose.
id The id of a specific agency you want.
name The name of a specific agency you want.
type The agency type id for the agency you are looking for.
abbrev The abbreviaton of the agency you want.

Agency Type

Usage: https://launchlibrary.net/1.0/agencytype/get

Example message:


		{
			"id": 5
		}
		
Name Description
name Name for the agency type.
id ID for the agency type.

Event Type

Usage: https://launchlibrary.net/1.0/eventtype/get

Example message:


		{
			"id":3
		}
		
Name Description
name Name for the event type.
id ID for the event type.

Launch

Usage: https://launchlibrary.net/1.0/launch/get

Example message:


		{
			"mode"  : "overview"
		}
		
Name Description
mode Modes are overview, summary, verbose.
fields An array of strings for fields returned in summary or verbose. The ID, name, net, inhold, and status fields are returned in summary if this is not present. All fields are returned in verbose if this is not present.

Search Options


If all of the following are omitted, it will return the next 10 launches by default.

startdate Date/Time to start search for. If this an
enddate Date/Time for the next launch attempt.
limit Limit of responses. Defaults to 10.
offset Offset, for pagination.
id The ID of the launch you are searching for.
name The ID of the launch you are searching for.
locationid The LocationID for the launch you are searching for.
rocketid The RocketID for the launch you are searching for.

Launch Event

Usage: https://launchlibrary.net/1.0/launchevent/get

Example message:


		{
			"mode" : "list"
		}
		
Name Description
mode Modes are: list, summary, verbose
id ID for the launch event.
name Name of launch event
type Event type.
parentid ID of launch.

Launch Status

Usage: https://launchlibrary.net/1.0/launchstatus/get

Example message:


		{
			"id":2
		}
		
Name Description
name Name for the launch status.
id ID for the launch status.

Location

Usage: https://launchlibrary.net/1.0/location/get

Example message:


		{
	   		"mode" : "list"
		}
		
Name Description
mode Modes are list, summary, verbose
countryCode ISO 3-letter country code for primary country of the location.
id ID of the location.
name Name of the location.

Mission

Usage: https://launchlibrary.net/1.0/mission/get

Example message:


		{
	   		"mode" : "list"
		}
		
Name Description
mode Modes are overview, summary, verbose.
fields An array of strings for fields returned in summary or verbose. The ID, name, net, inhold, and status fields are returned in summary if this is not present. All fields are returned in verbose if this is not present.

Search Options


If all of the following are omitted, it will return the first 10 missions returned by the db by default.

limit Limit of responses. Defaults to 10.
offset Offset, for pagination.
id The ID of the mission you are searching for.
name The ID of the mission you are searching for.
description The description of the mission you are searching for.
launchid The ID of the launch the mission is attached to.
type The type of mission.
agency An agency involved in the mission.

Mission Event

Usage: https://launchlibrary.net/1.0/missionevent/get

Example message:


		{
			"mode" : "list"
		}
		
Name Description
mode Modes are: list, summary, verbose
id ID for the mission event.
name Name of mission event
type Event type.
parentid ID of mission.

Mission Type

Usage: https://launchlibrary.net/1.0/missiontype/get

Example message:


		{
	   		"name" : "testevent",
			"description" : "test description"
		}
		
Name Description
name Name for the mission type.
description A description for the mission type.

Pad

Usage: https://launchlibrary.net/1.0/pad/get

Example message:


		{
			"mode" : "list"
		}
		
Name Description
mode Modes are: list, summary, verbose
id The ID of the pad.
name Name for the pad.
locationid The ID of the location for the pad.

Rocket

Usage: https://launchlibrary.net/1.0/rocket/get

Example message:


		{
	   		"mode" : "list"
		}
		
Name Description
mode Modes are list, summary, verbose.
id ID for the rocket.
name Name for the rocket.
configuration Configuration text for the rocket
familyID The ID for the rocket family.

Rocket Event

Usage: https://launchlibrary.net/1.0/rocketevent/get

Example message:


		{
			"mode" : "list"
	   		
		}
		
Name Description
mode Modes are: list, summary, verbose
id ID for the rocket event.
name Name of rocket event
type Event type.
parentid ID of rocket.

Rocket Family

Usage: https://launchlibrary.net/1.0/rocketfamily/get

Example message:


		{
	   		"id":7
		}
		
Name Description
name Name for the rocket family.
agencies Any agencies for the rocket family.