-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathswapi.txt
808 lines (720 loc) · 34.8 KB
/
swapi.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
© 2023 Paul Hallett & Juriy Bura
================================================================================
Introduction
Welcome to the swapi, the Star Wars API! This documentation should help you familiarise yourself with the resources available and how to consume them with HTTP requests. If you're after a native helper library then I suggest you scroll down and check out what's available. Read through the getting started section before you dive in. Most of your problems should be solved just by reading through it.
Getting started
Let's make our first API request to the Star Wars API!
Open up a terminal and use curl or httpie to make an API request for a resource. In the example below, we're trying to get the first planet, Tatooine:
http swapi.dev/api/planets/1/
We'll use httpie for our examples as it displays responses nicely and gives us a whole lot more useful information. If you don't want to download httpie, just use the curl command instead.
Here is the response we get:
HTTP/1.0 200 OK
Content-Type: application/json
{
"climate": "Arid",
"diameter": "10465",
"gravity": "1 standard",
"name": "Tatooine",
"orbital_period": "304",
"population": "200000",
"residents": [
"https://swapi.dev/api/people/1/",
"https://swapi.dev/api/people/2/",
...
],
"rotation_period": "23",
"surface_water": "1",
"terrain": "Dessert",
"url": "https://swapi.dev/api/planets/1/"
}
If your response looks slightly different don't panic. This is probably because more data has been added to swapi since we made this documentation.
================================================================================
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/
The documentation below assumes you are prepending the Base URL to the endpoints in order to make requests.
================================================================================
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.
================================================================================
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. If you find a mistake in the data, then tweet the author or email him.
================================================================================
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.
================================================================================
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. For more information on advanced search terms see here.
================================================================================
Encodings
SWAPI provides two encodings for you to render the data with:
JSON
JSON is the standard data format provided by SWAPI by default.
Wookiee
Wookiee is for our tall hairy allies who speak Wookiee, 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
================================================================================
/people/ -- get all the people resources
Example request:
http https://swapi.dev/api/people/1/
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"count": 82,
"next": "https://swapi.dev/api/people/?page=2",
"previous": null,
"results": [{
"birth_year": "19 BBY",
"eye_color": "Blue",
"films": [
"https://swapi.dev/api/films/1/",
...
],
"gender": "Male",
"hair_color": "Blond",
"height": "172",
"homeworld": "https://swapi.dev/api/planets/1/",
"mass": "77",
"name": "Luke Skywalker",
"skin_color": "Fair",
"created": "2014-12-09T13:50:51.644000Z",
"edited": "2014-12-10T13:52:43.172000Z",
"species": [
"https://swapi.dev/api/species/1/"
],
"starships": [
"https://swapi.dev/api/starships/12/",
...
],
"url": "https://swapi.dev/api/people/1/",
"vehicles": [
"https://swapi.dev/api/vehicles/14/"
...
]
}]
}
Attributes:
count: integer -- number of resources.
next: nullable integer --link to next page.
previous: nullable integer --link to previous page.
name string -- The name of this person.
birth_year string -- The birth year of the person, using the in-universe standard of BBY or ABY - Before the Battle of Yavin or After the Battle of Yavin. The Battle of Yavin is a battle that occurs at the end of Star Wars episode IV: A New Hope.
eye_color string -- The eye color of this person. Will be "unknown" if not known or "n/a" if the person does not have an eye.
gender string -- The gender of this person. Either "Male", "Female" or "unknown", "n/a" if the person does not have a gender.
hair_color string -- The hair color of this person. Will be "unknown" if not known or "n/a" if the person does not have hair.
height string -- The height of the person in centimeters.
mass string -- The mass of the person in kilograms.
skin_color string -- The skin color of this person.
homeworld string -- The URL of a planet resource, a planet that this person was born on or inhabits.
films array -- An array of film resource URLs that this person has been in.
species array -- An array of species resource URLs that this person belongs to.
starships array -- An array of starship resource URLs that this person has piloted.
vehicles array -- An array of vehicle resource URLs that this person has piloted.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
name
================================================================================
/people/:id/ -- get a specific people resource
/people/schema/ -- view the JSON schema for this resource
Example request:
http https://swapi.dev/api/people/1/
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"birth_year": "19 BBY",
"eye_color": "Blue",
"films": [
"https://swapi.dev/api/films/1/",
...
],
"gender": "Male",
"hair_color": "Blond",
"height": "172",
"homeworld": "https://swapi.dev/api/planets/1/",
"mass": "77",
"name": "Luke Skywalker",
"skin_color": "Fair",
"created": "2014-12-09T13:50:51.644000Z",
"edited": "2014-12-10T13:52:43.172000Z",
"species": [
"https://swapi.dev/api/species/1/"
],
"starships": [
"https://swapi.dev/api/starships/12/",
...
],
"url": "https://swapi.dev/api/people/1/",
"vehicles": [
"https://swapi.dev/api/vehicles/14/"
...
]
}
Attributes:
name string -- The name of this person.
birth_year string -- The birth year of the person, using the in-universe standard of BBY or ABY - Before the Battle of Yavin or After the Battle of Yavin. The Battle of Yavin is a battle that occurs at the end of Star Wars episode IV: A New Hope.
eye_color string -- The eye color of this person. Will be "unknown" if not known or "n/a" if the person does not have an eye.
gender string -- The gender of this person. Either "Male", "Female" or "unknown", "n/a" if the person does not have a gender.
hair_color string -- The hair color of this person. Will be "unknown" if not known or "n/a" if the person does not have hair.
height string -- The height of the person in centimeters.
mass string -- The mass of the person in kilograms.
skin_color string -- The skin color of this person.
homeworld string -- The URL of a planet resource, a planet that this person was born on or inhabits.
films array -- An array of film resource URLs that this person has been in.
species array -- An array of species resource URLs that this person belongs to.
starships array -- An array of starship resource URLs that this person has piloted.
vehicles array -- An array of vehicle resource URLs that this person has piloted.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
name
================================================================================
/films/ -- get all the film resources
Example request:
http https://swapi.dev/api/films/
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"count": 82,
"next": "https://swapi.dev/api/people/?page=2",
"previous": null,
"results": [{
"characters": [
"https://swapi.dev/api/people/1/",
...
],
"created": "2014-12-10T14:23:31.880000Z",
"director": "George Lucas",
"edited": "2014-12-12T11:24:39.858000Z",
"episode_id": 4,
"opening_crawl": "It is a period of civil war.\n\nRebel spaceships, striking\n\nfrom a hidden base, have won\n\ntheir first victory against\n\nthe evil Galactic Empire.\n\n\n\nDuring the battle, Rebel\n\nspies managed to steal secret\r\nplans to the Empire's\n\nultimate weapon, the DEATH\n\nSTAR, an armored space\n\nstation with enough power\n\nto destroy an entire planet.\n\n\n\nPursued by the Empire's\n\nsinister agents, Princess\n\nLeia races home aboard her\n\nstarship, custodian of the\n\nstolen plans that can save her\n\npeople and restore\n\nfreedom to the galaxy....",
"planets": [
"https://swapi.dev/api/planets/1/",
...
],
"producer": "Gary Kurtz, Rick McCallum",
"release_date": "1977-05-25",
"species": [
"https://swapi.dev/api/species/1/",
...
],
"starships": [
"https://swapi.dev/api/starships/2/",
...
],
"title": "A New Hope",
"url": "https://swapi.dev/api/films/1/",
"vehicles": [
"https://swapi.dev/api/vehicles/4/",
...
]
}}
}
Attributes:
count: integer -- number of resources.
next: nullable integer --link to next page.
previous: nullable integer --link to previous page.
title string -- The title of this film
episode_id integer -- The episode number of this film.
opening_crawl string -- The opening paragraphs at the beginning of this film.
director string -- The name of the director of this film.
producer string -- The name(s) of the producer(s) of this film. Comma separated.
release_date date -- The ISO 8601 date format of film release at original creator country.
species array -- An array of species resource URLs that are in this film.
starships array -- An array of starship resource URLs that are in this film.
vehicles array -- An array of vehicle resource URLs that are in this film.
characters array -- An array of people resource URLs that are in this film.
planets array -- An array of planet resource URLs that are in this film.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
title
================================================================================
/films/:id/ -- get a specific film resource
/films/schema/ -- view the JSON schema for this resource
Example request:
http https://swapi.dev/api/films/1/
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"characters": [
"https://swapi.dev/api/people/1/",
...
],
"created": "2014-12-10T14:23:31.880000Z",
"director": "George Lucas",
"edited": "2014-12-12T11:24:39.858000Z",
"episode_id": 4,
"opening_crawl": "It is a period of civil war.\n\nRebel spaceships, striking\n\nfrom a hidden base, have won\n\ntheir first victory against\n\nthe evil Galactic Empire.\n\n\n\nDuring the battle, Rebel\n\nspies managed to steal secret\r\nplans to the Empire's\n\nultimate weapon, the DEATH\n\nSTAR, an armored space\n\nstation with enough power\n\nto destroy an entire planet.\n\n\n\nPursued by the Empire's\n\nsinister agents, Princess\n\nLeia races home aboard her\n\nstarship, custodian of the\n\nstolen plans that can save her\n\npeople and restore\n\nfreedom to the galaxy....",
"planets": [
"https://swapi.dev/api/planets/1/",
...
],
"producer": "Gary Kurtz, Rick McCallum",
"release_date": "1977-05-25",
"species": [
"https://swapi.dev/api/species/1/",
...
],
"starships": [
"https://swapi.dev/api/starships/2/",
...
],
"title": "A New Hope",
"url": "https://swapi.dev/api/films/1/",
"vehicles": [
"https://swapi.dev/api/vehicles/4/",
...
]
}
Attributes:
title string -- The title of this film
episode_id integer -- The episode number of this film.
opening_crawl string -- The opening paragraphs at the beginning of this film.
director string -- The name of the director of this film.
producer string -- The name(s) of the producer(s) of this film. Comma separated.
release_date date -- The ISO 8601 date format of film release at original creator country.
species array -- An array of species resource URLs that are in this film.
starships array -- An array of starship resource URLs that are in this film.
vehicles array -- An array of vehicle resource URLs that are in this film.
characters array -- An array of people resource URLs that are in this film.
planets array -- An array of planet resource URLs that are in this film.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
title
================================================================================
/starships/ -- get all the starship resources
Example request:
http https://swapi.dev/api/starships
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"count": 82,
"next": "https://swapi.dev/api/people/?page=2",
"previous": null,
"results": [{
"MGLT": "10 MGLT",
"cargo_capacity": "1000000000000",
"consumables": "3 years",
"cost_in_credits": "1000000000000",
"created": "2014-12-10T16:36:50.509000Z",
"crew": "342953",
"edited": "2014-12-10T16:36:50.509000Z",
"hyperdrive_rating": "4.0",
"length": "120000",
"manufacturer": "Imperial Department of Military Research, Sienar Fleet Systems",
"max_atmosphering_speed": "n/a",
"model": "DS-1 Orbital Battle Station",
"name": "Death Star",
"passengers": "843342",
"films": [
"https://swapi.dev/api/films/1/"
],
"pilots": [],
"starship_class": "Deep Space Mobile Battlestation",
"url": "https://swapi.dev/api/starships/9/"
}]
}
Attributes:
count: integer -- number of resources.
next: nullable integer --link to next page.
previous: nullable integer --link to previous page.
name string -- The name of this starship. The common name, such as "Death Star".
model string -- The model or official name of this starship. Such as "T-65 X-wing" or "DS-1 Orbital Battle Station".
starship_class string -- The class of this starship, such as "Starfighter" or "Deep Space Mobile Battlestation"
manufacturer string -- The manufacturer of this starship. Comma separated if more than one.
cost_in_credits string -- The cost of this starship new, in galactic credits.
length string -- The length of this starship in meters.
crew string -- The number of personnel needed to run or pilot this starship.
passengers string -- The number of non-essential people this starship can transport.
max_atmosphering_speed string -- The maximum speed of this starship in the atmosphere. "N/A" if this starship is incapable of atmospheric flight.
hyperdrive_rating string -- The class of this starships hyperdrive.
MGLT string -- The Maximum number of Megalights this starship can travel in a standard hour. A "Megalight" is a standard unit of distance and has never been defined before within the Star Wars universe. This figure is only really useful for measuring the difference in speed of starships. We can assume it is similar to AU, the distance between our Sun (Sol) and Earth.
cargo_capacity string -- The maximum number of kilograms that this starship can transport.
consumables *string
The maximum length of time that this starship can provide consumables for its entire crew without having to resupply.
films array -- An array of Film URL Resources that this starship has appeared in.
pilots array -- An array of People URL Resources that this starship has been piloted by.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
name
model
================================================================================
/starships/:id/ -- get a specific starship resource
/starships/schema/ -- view the JSON schema for this resource
Example request:
http https://swapi.dev/api/starships/9/
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"MGLT": "10 MGLT",
"cargo_capacity": "1000000000000",
"consumables": "3 years",
"cost_in_credits": "1000000000000",
"created": "2014-12-10T16:36:50.509000Z",
"crew": "342953",
"edited": "2014-12-10T16:36:50.509000Z",
"hyperdrive_rating": "4.0",
"length": "120000",
"manufacturer": "Imperial Department of Military Research, Sienar Fleet Systems",
"max_atmosphering_speed": "n/a",
"model": "DS-1 Orbital Battle Station",
"name": "Death Star",
"passengers": "843342",
"films": [
"https://swapi.dev/api/films/1/"
],
"pilots": [],
"starship_class": "Deep Space Mobile Battlestation",
"url": "https://swapi.dev/api/starships/9/"
}
Attributes:
name string -- The name of this starship. The common name, such as "Death Star".
model string -- The model or official name of this starship. Such as "T-65 X-wing" or "DS-1 Orbital Battle Station".
starship_class string -- The class of this starship, such as "Starfighter" or "Deep Space Mobile Battlestation"
manufacturer string -- The manufacturer of this starship. Comma separated if more than one.
cost_in_credits string -- The cost of this starship new, in galactic credits.
length string -- The length of this starship in meters.
crew string -- The number of personnel needed to run or pilot this starship.
passengers string -- The number of non-essential people this starship can transport.
max_atmosphering_speed string -- The maximum speed of this starship in the atmosphere. "N/A" if this starship is incapable of atmospheric flight.
hyperdrive_rating string -- The class of this starships hyperdrive.
MGLT string -- The Maximum number of Megalights this starship can travel in a standard hour. A "Megalight" is a standard unit of distance and has never been defined before within the Star Wars universe. This figure is only really useful for measuring the difference in speed of starships. We can assume it is similar to AU, the distance between our Sun (Sol) and Earth.
cargo_capacity string -- The maximum number of kilograms that this starship can transport.
consumables *string
The maximum length of time that this starship can provide consumables for its entire crew without having to resupply.
films array -- An array of Film URL Resources that this starship has appeared in.
pilots array -- An array of People URL Resources that this starship has been piloted by.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
name
model
================================================================================
/vehicles/ -- get all the vehicle resources
Example request:
http https://swapi.dev/api/vehicles
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"count": 82,
"next": "https://swapi.dev/api/people/?page=2",
"previous": null,
"results": [{
"cargo_capacity": "50000",
"consumables": "2 months",
"cost_in_credits": "150000",
"created": "2014-12-10T15:36:25.724000Z",
"crew": "46",
"edited": "2014-12-10T15:36:25.724000Z",
"length": "36.8",
"manufacturer": "Corellia Mining Corporation",
"max_atmosphering_speed": "30",
"model": "Digger Crawler",
"name": "Sand Crawler",
"passengers": "30",
"pilots": [],
"films": [
"https://swapi.dev/api/films/1/"
],
"url": "https://swapi.dev/api/vehicles/4/",
"vehicle_class": "wheeled"
}]
}
Attributes:
count: integer -- number of resources.
next: nullable integer --link to next page.
previous: nullable integer --link to previous page.
name string -- The name of this vehicle. The common name, such as "Sand Crawler" or "Speeder bike".
model string -- The model or official name of this vehicle. Such as "All-Terrain Attack Transport".
vehicle_class string -- The class of this vehicle, such as "Wheeled" or "Repulsorcraft".
manufacturer string -- The manufacturer of this vehicle. Comma separated if more than one.
length string -- The length of this vehicle in meters.
cost_in_credits string -- The cost of this vehicle new, in Galactic Credits.
crew string -- The number of personnel needed to run or pilot this vehicle.
passengers string -- The number of non-essential people this vehicle can transport.
max_atmosphering_speed string -- The maximum speed of this vehicle in the atmosphere.
cargo_capacity string -- The maximum number of kilograms that this vehicle can transport.
consumables *string
The maximum length of time that this vehicle can provide consumables for its entire crew without having to resupply.
films array -- An array of Film URL Resources that this vehicle has appeared in.
pilots array -- An array of People URL Resources that this vehicle has been piloted by.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
name
model
================================================================================
/vehicles/:id/ -- get a specific vehicle resource
/vehicles/schema/ -- view the JSON schema for this resource
Example request:
http https://swapi.dev/api/vehicles/4/
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"cargo_capacity": "50000",
"consumables": "2 months",
"cost_in_credits": "150000",
"created": "2014-12-10T15:36:25.724000Z",
"crew": "46",
"edited": "2014-12-10T15:36:25.724000Z",
"length": "36.8",
"manufacturer": "Corellia Mining Corporation",
"max_atmosphering_speed": "30",
"model": "Digger Crawler",
"name": "Sand Crawler",
"passengers": "30",
"pilots": [],
"films": [
"https://swapi.dev/api/films/1/"
],
"url": "https://swapi.dev/api/vehicles/4/",
"vehicle_class": "wheeled"
}
Attributes:
name string -- The name of this vehicle. The common name, such as "Sand Crawler" or "Speeder bike".
model string -- The model or official name of this vehicle. Such as "All-Terrain Attack Transport".
vehicle_class string -- The class of this vehicle, such as "Wheeled" or "Repulsorcraft".
manufacturer string -- The manufacturer of this vehicle. Comma separated if more than one.
length string -- The length of this vehicle in meters.
cost_in_credits string -- The cost of this vehicle new, in Galactic Credits.
crew string -- The number of personnel needed to run or pilot this vehicle.
passengers string -- The number of non-essential people this vehicle can transport.
max_atmosphering_speed string -- The maximum speed of this vehicle in the atmosphere.
cargo_capacity string -- The maximum number of kilograms that this vehicle can transport.
consumables *string
The maximum length of time that this vehicle can provide consumables for its entire crew without having to resupply.
films array -- An array of Film URL Resources that this vehicle has appeared in.
pilots array -- An array of People URL Resources that this vehicle has been piloted by.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
name
model
================================================================================
/species/ -- get all the species resources
Example request:
http https://swapi.dev/api/species
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"count": 82,
"next": "https://swapi.dev/api/people/?page=2",
"previous": null,
"results": [{
"average_height": "2.1",
"average_lifespan": "400",
"classification": "Mammal",
"created": "2014-12-10T16:44:31.486000Z",
"designation": "Sentient",
"edited": "2014-12-10T16:44:31.486000Z",
"eye_colors": "blue, green, yellow, brown, golden, red",
"hair_colors": "black, brown",
"homeworld": "https://swapi.dev/api/planets/14/",
"language": "Shyriiwook",
"name": "Wookie",
"people": [
"https://swapi.dev/api/people/13/"
],
"films": [
"https://swapi.dev/api/films/1/",
"https://swapi.dev/api/films/2/"
],
"skin_colors": "gray",
"url": "https://swapi.dev/api/species/3/"
}]
}
Attributes:
count: integer -- number of resources.
next: nullable integer --link to next page.
previous: nullable integer --link to previous page.
name string -- The name of this species.
classification string -- The classification of this species, such as "mammal" or "reptile".
designation string -- The designation of this species, such as "sentient".
average_height string -- The average height of this species in centimeters.
average_lifespan string -- The average lifespan of this species in years.
eye_colors string -- A comma-separated string of common eye colors for this species, "none" if this species does not typically have eyes.
hair_colors string -- A comma-separated string of common hair colors for this species, "none" if this species does not typically have hair.
skin_colors string -- A comma-separated string of common skin colors for this species, "none" if this species does not typically have skin.
language string -- The language commonly spoken by this species.
homeworld string -- The URL of a planet resource, a planet that this species originates from.
people array -- An array of People URL Resources that are a part of this species.
films array -- An array of Film URL Resources that this species has appeared in.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
name
================================================================================
/species/:id/ -- get a specific species resource
/species/schema/ -- view the JSON schema for this resource
Example request:
http https://swapi.dev/api/species/3/
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"average_height": "2.1",
"average_lifespan": "400",
"classification": "Mammal",
"created": "2014-12-10T16:44:31.486000Z",
"designation": "Sentient",
"edited": "2014-12-10T16:44:31.486000Z",
"eye_colors": "blue, green, yellow, brown, golden, red",
"hair_colors": "black, brown",
"homeworld": "https://swapi.dev/api/planets/14/",
"language": "Shyriiwook",
"name": "Wookie",
"people": [
"https://swapi.dev/api/people/13/"
],
"films": [
"https://swapi.dev/api/films/1/",
"https://swapi.dev/api/films/2/"
],
"skin_colors": "gray",
"url": "https://swapi.dev/api/species/3/"
}
Attributes:
name string -- The name of this species.
classification string -- The classification of this species, such as "mammal" or "reptile".
designation string -- The designation of this species, such as "sentient".
average_height string -- The average height of this species in centimeters.
average_lifespan string -- The average lifespan of this species in years.
eye_colors string -- A comma-separated string of common eye colors for this species, "none" if this species does not typically have eyes.
hair_colors string -- A comma-separated string of common hair colors for this species, "none" if this species does not typically have hair.
skin_colors string -- A comma-separated string of common skin colors for this species, "none" if this species does not typically have skin.
language string -- The language commonly spoken by this species.
homeworld string -- The URL of a planet resource, a planet that this species originates from.
people array -- An array of People URL Resources that are a part of this species.
films array -- An array of Film URL Resources that this species has appeared in.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
name
================================================================================
/planets/ -- get all the planets resources
Example request:
http https://swapi.dev/api/planets/
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"count": 82,
"next": "https://swapi.dev/api/people/?page=2",
"previous": null,
"results": [{
"climate": "Arid",
"created": "2014-12-09T13:50:49.641000Z",
"diameter": "10465",
"edited": "2014-12-15T13:48:16.167217Z",
"films": [
"https://swapi.dev/api/films/1/",
...
],
"gravity": "1",
"name": "Tatooine",
"orbital_period": "304",
"population": "120000",
"residents": [
"https://swapi.dev/api/people/1/",
...
],
"rotation_period": "23",
"surface_water": "1",
"terrain": "Dessert",
"url": "https://swapi.dev/api/planets/1/"
}]
}
Attributes:
count: integer -- number of resources.
next: nullable integer --link to next page.
previous: nullable integer --link to previous page.
name string -- The name of this planet.
diameter string -- The diameter of this planet in kilometers.
rotation_period string -- The number of standard hours it takes for this planet to complete a single rotation on its axis.
orbital_period string -- The number of standard days it takes for this planet to complete a single orbit of its local star.
gravity string -- A number denoting the gravity of this planet, where "1" is normal or 1 standard G. "2" is twice or 2 standard Gs. "0.5" is half or 0.5 standard Gs.
population string -- The average population of sentient beings inhabiting this planet.
climate string -- The climate of this planet. Comma separated if diverse.
terrain string -- The terrain of this planet. Comma separated if diverse.
surface_water string -- The percentage of the planet surface that is naturally occurring water or bodies of water.
residents array -- An array of People URL Resources that live on this planet.
films array -- An array of Film URL Resources that this planet has appeared in.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
name
================================================================================
/planets/:id/ -- get a specific planets resource
/planets/schema/ -- view the JSON schema for this resource
Example request:
http https://swapi.dev/api/planets/1/
Example response:
HTTP/1.0 200 OK
Content-Type: application/json
{
"climate": "Arid",
"created": "2014-12-09T13:50:49.641000Z",
"diameter": "10465",
"edited": "2014-12-15T13:48:16.167217Z",
"films": [
"https://swapi.dev/api/films/1/",
...
],
"gravity": "1",
"name": "Tatooine",
"orbital_period": "304",
"population": "120000",
"residents": [
"https://swapi.dev/api/people/1/",
...
],
"rotation_period": "23",
"surface_water": "1",
"terrain": "Dessert",
"url": "https://swapi.dev/api/planets/1/"
}
Attributes:
name string -- The name of this planet.
diameter string -- The diameter of this planet in kilometers.
rotation_period string -- The number of standard hours it takes for this planet to complete a single rotation on its axis.
orbital_period string -- The number of standard days it takes for this planet to complete a single orbit of its local star.
gravity string -- A number denoting the gravity of this planet, where "1" is normal or 1 standard G. "2" is twice or 2 standard Gs. "0.5" is half or 0.5 standard Gs.
population string -- The average population of sentient beings inhabiting this planet.
climate string -- The climate of this planet. Comma separated if diverse.
terrain string -- The terrain of this planet. Comma separated if diverse.
surface_water string -- The percentage of the planet surface that is naturally occurring water or bodies of water.
residents array -- An array of People URL Resources that live on this planet.
films array -- An array of Film URL Resources that this planet has appeared in.
url string -- the hypermedia URL of this resource.
created string -- the ISO 8601 date format of the time that this resource was created.
edited string -- the ISO 8601 date format of the time that this resource was edited.
Search Fields:
name
================================================================================