sfapi.md

Protocol Documentation

Table of Contents

• sfapi.proto

  • Film

  • GetFilmRequest

  • GetFilmResponse

  • GetPersonRequest

  • GetPersonResponse

  • GetPlanetRequest

  • GetPlanetResponse

  • GetSpeciesRequest

  • GetSpeciesResponse

  • GetStarshipRequest

  • GetStarshipResponse

  • GetVehicleRequest

  • GetVehicleResponse

  • InvalidKey

  • ListFilmsRequest

  • ListFilmsResponse

  • ListPeopleRequest

  • ListPeopleResponse

  • ListPlanetsRequest

  • ListPlanetsResponse

  • ListSpeciesRequest

  • ListSpeciesResponse

  • ListStarshipActionsRequest

  • ListStarshipsRequest

  • ListStarshipsResponse

  • ListVehiclesRequest

  • ListVehiclesResponse

  • Person

  • Planet

  • Species

  • Starship

  • StarshipAction

  • ValidateSpeciesRequest

  • ValidateSpeciesResponse

  • Vehicle

  • StarshipAction.Action

  • Starfriends

• Scalar Value Types

Top

sfapi.proto

Film

Field	Type	Label	Description
title	string
episode_id	int32
opening_crawl	string
director	string
producer	string
release_date	string
character_ids	string	repeated	Person.id
planet_ids	string	repeated	Planet.id
starship_ids	string	repeated	Starship.id
vehicle_ids	string	repeated	Vehicle.id
species_ids	string	repeated	Species.id
id	string

GetFilmRequest

Field	Type	Label	Description
id	string

GetFilmResponse

Field	Type	Label	Description
film	Film

GetPersonRequest

Field	Type	Label	Description
id	string

GetPersonResponse

Field	Type	Label	Description
person	Person

GetPlanetRequest

Field	Type	Label	Description
id	string

GetPlanetResponse

Field	Type	Label	Description
planet	Planet

GetSpeciesRequest

Field	Type	Label	Description
id	string

GetSpeciesResponse

Field	Type	Label	Description
species	Species

GetStarshipRequest

Field	Type	Label	Description
id	string

GetStarshipResponse

Field	Type	Label	Description
starship	Starship

GetVehicleRequest

Field	Type	Label	Description
id	string

GetVehicleResponse

Field	Type	Label	Description
vehicle	Vehicle

InvalidKey

Field	Type	Label	Description
key	string
message	string

ListFilmsRequest

ListFilmsResponse

Field	Type	Label	Description
films	Film	repeated

ListPeopleRequest

ListPeopleResponse

Field	Type	Label	Description
people	Person	repeated

ListPlanetsRequest

ListPlanetsResponse

Field	Type	Label	Description
planets	Planet	repeated

ListSpeciesRequest

ListSpeciesResponse

Field	Type	Label	Description
species	Species	repeated

ListStarshipActionsRequest

ListStarshipsRequest

ListStarshipsResponse

Field	Type	Label	Description
starships	Starship	repeated

ListVehiclesRequest

ListVehiclesResponse

Field	Type	Label	Description
vehicles	Vehicle	repeated

Person

Field	Type	Label	Description
name	string
height	int32
mass	float
hair_color	string
skin_color	string
eye_color	string
birth_year	string
gender	string
homeworld	string
film_ids	string	repeated	Film.id
species_ids	string	repeated	Species.id
vehicle_ids	string	repeated	Vehicle.id
starship_ids	string	repeated	Starship.id
id	string

Planet

Field	Type	Label	Description
name	string
rotation_period	int32
orbital_period	int32
diameter	int32
climate	string
gravity	float
terrain	string
surface_water	float
population	int64
resident_ids	string	repeated	Person.id
film_ids	string	repeated	Film.id
id	string

Species

Field	Type	Label	Description
name	string
classification	string
designation	string
average_height	int32
skin_colors	string
eye_colors	string
average_lifespan	int32
homeworld	string
language	string
people_ids	string	repeated	Person.id
film_ids	string	repeated	Film.id
id	string
hair_colors	string

Starship

Field	Type	Label	Description
name	string
model	string
manufacturer	string
cost_in_credits	int64
length	float
crew	int32
passengers	int32
cargo_capacity	int64
consumables	string
hyperdrive_rating	float
mglt	int32
starship_class	string
pilot_ids	string	repeated	Person.id
film_ids	string	repeated	Film.id
id	string
max_atmosphering_speed	int64

StarshipAction

Field	Type	Label	Description
starship	Starship
action	StarshipAction.Action

ValidateSpeciesRequest

Field	Type	Label	Description
name	string

ValidateSpeciesResponse

Vehicle

Field	Type	Label	Description
name	string
model	string
manufacturer	string
cost_in_credits	int32
length	float
max_atmosphering_speed	int32
crew	int32
passengers	int32
cargo_capacity	int32
consumables	string
vehicle_class	string
pilot_ids	string	repeated	Person.id
film_ids	string	repeated	Film.id
id	string

StarshipAction.Action

Name	Number	Description
TOOKOFF	0
LANDED	1
HYPERDRIVE	2
HIDING_IN_A_MOUTH	3

Starfriends

Method Name	Request Type	Response Type	Description
GetFilm	GetFilmRequest	GetFilmResponse	Get a single Film
ListFilms	ListFilmsRequest	ListFilmsResponse	Get a list of Films
GetVehicle	GetVehicleRequest	GetVehicleResponse	Get a single Vehicle
ListVehicles	ListVehiclesRequest	ListVehiclesResponse	Get a list of Vehicles
GetStarship	GetStarshipRequest	GetStarshipResponse	Get a single Starship
ListStarships	ListStarshipsRequest	ListStarshipsResponse	Get a list of Starships
GetSpecies	GetSpeciesRequest	GetSpeciesResponse	Get a single Species
ListSpecies	ListSpeciesRequest	ListSpeciesResponse	Get a list of Species
GetPlanet	GetPlanetRequest	GetPlanetResponse	Get a single Planet
ListPlanets	ListPlanetsRequest	ListPlanetsResponse	Get a list of Planets
GetPerson	GetPersonRequest	GetPersonResponse	Get a single Person
ListPeople	ListPeopleRequest	ListPeopleResponse	Get a list of People
ListStarshipActions	ListStarshipActionsRequest	StarshipAction	Watch starships doing stuff, in realtime
ValidateSpecies	ValidateSpeciesRequest	ValidateSpeciesResponse	is the given species valid?

Scalar Value Types

.proto Type	Notes	C++ Type	Java Type	Python Type
double		double	double	float
float		float	float	float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long
uint32	Uses variable-length encoding.	uint32	int	int/long
uint64	Uses variable-length encoding.	uint64	long	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long
sfixed32	Always four bytes.	int32	int	int
sfixed64	Always eight bytes.	int64	long	int/long
bool		bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str