SWAPI.dev

SWAPI.dev

1. Base URL

   • The Base URL is the root URL for all of the API, if you ever make a request to swapi and you get back a 404 NOT FOUND response then check the Base URL first.
     • The Base URL for swapi is: https://swapi.dev/api/

2. Rate limiting

   • Swapi has rate limiting to prevent malicious abuse (as if anyone would abuse Star Wars data!) and to make sure our service can handle a potentially large amount of traffic. Rate limiting is done via IP address and is currently limited to 10,000 API request per day. This is enough to request all the data on the website at least ten times over. There should be no reason for hitting the rate limit.

3. Authentication

   • Swapi is a completely open API. No authentication is required to query and get data. This also means that we've limited what you can do to just GET-ing the data.

4. JSON Schema

   • All resources support JSON Schema. Making a request to "/api/<resource>/schema" will give you the details of that resource. This will allow you to programmatically inspect the attributes of that resource and their types.

5. Searching

   • All resources support a search parameter that filters the set of resources returned. This allows you to make queries like: "https://swapi.dev/api/people/?search=r2" All searches will use case-insensitive partial matches on the set of search fields. To see the set of search fields for each resource, check out the individual resource documentation.

6. Encoding

   • There are two encoders to render data with
     • JSON
       • SWAPI uses JSON as the standard data format
     • Wookie
       • This encoding is identical to JSON except with wookiee translations. Using the wookiee renderer is easy, just append "?format=wookiee" to your urls: "https://swapi.dev/api/planets/1/?format=wookiee"

7. Resources

   • Root
     • People
       • Endpoints are: "people/" - gets all people resources "people/:id/" - gets a specific people resource "people/schema/" - view the JSON schema for this resource
       • Attributes
         • name
         • birth_year
         • eye_color
         • gender
         • hair_color
         • height
         • mass
         • skin_color
         • homeworld
         • films
         • species
         • starships
         • vehicles
         • url
         • created
         • edited
       • Example
         • Request
           • https://swapi.dev/api/people/1/
         • Repond
     • Films
       • Attributes
         • title
         • episode_id
         • opening_crawl
         • director
         • producer
         • release_date
         • species
         • starships
         • vehicles
         • characters
         • planets
         • url
         • created
         • edited
     • Planets
       • name
       • diameter
       • rotation_period
       • orbital_period
       • gravity
       • population
       • climate
       • terrain
       • surface_water
       • residents
       • films
       • url
       • created
       • edited
     • Species
       • name
       • classification
       • designation
       • average_height
       • average_lifespan
       • eye_colors
       • hair_colors
       • skin_colors
       • language
       • homeworld
       • people
       • films
       • url
       • created
       • edited
     • Starships
       • name
       • model
       • starship_class
       • manufacturer
       • crew
       • length
       • cost_in_credits
       • passengers
       • max_atmosphering_speed
       • hyperdrive_rating
       • MGLT
       • cargo_capacity
       • consumables
       • films
       • pilots
       • url
       • created
       • edited
     • Vehicles
       • name
       • model
       • vehicle_class
       • manufacturer
       • length
       • cost_in_credits
       • crew
       • passengers
       • max_atmosphering_speed
       • cargo_capacity
       • consumables
       • films
       • pilots
       • url
       • created
       • edited

Images and files in the map