# Star Wars API Scraper - Characters & Planets (`lulzasaur/swapi-scraper`) Actor

Scrape Star Wars universe data including characters, planets, films, species, vehicles and starships from SWAPI. Search and filter results.

- **URL**: https://apify.com/lulzasaur/swapi-scraper.md
- **Developed by:** [lulz bot](https://apify.com/lulzasaur) (community)
- **Categories:** E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $10.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Star Wars API Scraper (SWAPI)

Scrape the Star Wars universe data from SWAPI. Get characters, planets, films, species, vehicles, and starships with full search and pagination support.

### Features

- **6 resource types**: People, planets, films, species, vehicles, starships
- **Search**: Filter by name/title to find specific entries
- **Full pagination**: Automatically follows all pages for complete datasets
- **Rich data**: All fields from the SWAPI API, properly transformed
- **Configurable limit**: Control how many results to return

### Output Fields

#### People

| Field | Description |
|-------|-------------|
| `name` | Character name |
| `height` | Height in cm |
| `mass` | Mass in kg |
| `hairColor` | Hair color |
| `skinColor` | Skin color |
| `eyeColor` | Eye color |
| `birthYear` | Birth year (BBY/ABY) |
| `gender` | Gender |
| `homeworld` | Homeworld API URL |
| `films` | Film appearance URLs |

#### Planets

| Field | Description |
|-------|-------------|
| `name` | Planet name |
| `climate` | Climate type |
| `terrain` | Terrain type |
| `population` | Population count |
| `diameter` | Diameter in km |
| `gravity` | Gravity rating |

#### Films

| Field | Description |
|-------|-------------|
| `title` | Film title |
| `episodeId` | Episode number |
| `director` | Director name |
| `producer` | Producer(s) |
| `releaseDate` | Release date |
| `openingCrawl` | Opening text crawl |

### Input Options

- **Mode**: Resource type (people, planets, films, species, vehicles, starships)
- **Search Query**: Filter results by name (e.g. "Luke", "Tatooine")
- **Limit**: Max results to return (0 = all)

### Use Cases

- **Apps & Games**: Build Star Wars reference apps or trivia games
- **Data analysis**: Analyze the Star Wars universe dataset
- **Education**: Learn about APIs and data scraping with a fun dataset
- **Content creation**: Generate Star Wars content with accurate data
- **Chatbots**: Power Star Wars trivia bots with structured data

### Example Output

```json
{
  "name": "Luke Skywalker",
  "type": "person",
  "height": "172",
  "mass": "77",
  "hairColor": "blond",
  "eyeColor": "blue",
  "birthYear": "19BBY",
  "gender": "male",
  "homeworld": "https://swapi.dev/api/planets/1/",
  "films": ["https://swapi.dev/api/films/1/", "..."],
  "scrapedAt": "2026-04-26T12:00:00.000Z"
}
```

### Data Source

- [SWAPI](https://swapi.dev/) -- The Star Wars API, free and open

***

### Run on Apify

This scraper runs on the [Apify platform](https://apify.com/?fpr=lulzasaur) -- a full-stack web scraping and automation cloud. Sign up for a free account to get started with 30-day trial of all features.

[Try Apify free](https://apify.com/?fpr=lulzasaur)

# Actor input Schema

## `mode` (type: `string`):

Which Star Wars resource to scrape.

## `searchQuery` (type: `string`):

Search term to filter results (e.g. 'Luke', 'Tatooine'). Leave empty to get all.

## `limit` (type: `integer`):

Maximum number of results to return. 0 = all.

## `proxyConfiguration` (type: `object`):

Optional proxy to use.

## Actor input object example

```json
{
  "mode": "people",
  "searchQuery": "",
  "limit": 0
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("lulzasaur/swapi-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("lulzasaur/swapi-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call lulzasaur/swapi-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,lulzasaur/swapi-scraper"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/OFTtgIPFBz5svd1PL/builds/tsuIuCHtksD2cldFU/openapi.json