Ships API

https://ships.hackclub.com/docs
Admin
Ships API is a RESTful API that provides access to Hack Club's You Ship, We Ship (YSWS) project...
Tokens:842
Snippets:5
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /api/v1/me

Source: https://ships.hackclub.com/docs

Authenticated endpoint that returns all project entries for the authenticated user.

```APIDOC
## GET /api/v1/me

### Description
Returns all project entries for the authenticated user. This endpoint requires authentication.

### Method
GET

### Endpoint
/api/v1/me

### Response
#### Success Response (200)
- **[]** (array) - Array of YswsProjectEntry objects
```

--------------------------------

### GET /api/v1/dashboard

Source: https://ships.hackclub.com/docs

Authenticated endpoint that returns dashboard data for the authenticated user.

```APIDOC
## GET /api/v1/dashboard

### Description
Returns dashboard data for the authenticated user. This endpoint requires authentication.

### Method
GET

### Endpoint
/api/v1/dashboard

### Response
#### Success Response (200)
- **user.email** (string) - User's email
- **user.name** (string) - User's display name
- **entries** (array) - Array of user's project entries
```

--------------------------------

### GET /api/v1/stats

Source: https://ships.hackclub.com/docs

Public endpoint that returns global statistics for all projects. The response is cached for 5 minutes.

```APIDOC
## GET /api/v1/stats

### Description
Returns global statistics for all projects. This endpoint is public and the response is cached for 5 minutes.

### Method
GET

### Endpoint
/api/v1/stats

### Response
#### Success Response (200)
- **total_projects** (integer) - Total number of projects
- **total_hours** (number) - Sum of all hours spent
- **total_stars** (integer) - Sum of all GitHub stars
- **viral_projects** (integer) - Projects with >5 stars
- **projects_by_country** (object) - Top 15 countries by project count
- **projects_by_ysws** (object) - Projects grouped by YSWS program
- **top_starred** (array) - Top 10 starred projects
- **recent_projects** (array) - 10 most recently approved projects
```

--------------------------------

### GET /api/v1/ysws_entries

Source: https://ships.hackclub.com/docs

Public endpoint that returns all YSWS project entries. The response is cached for 5 minutes.

```APIDOC
## GET /api/v1/ysws_entries

### Description
Returns all YSWS project entries. This endpoint is public and the response is cached for 5 minutes.

### Method
GET

### Endpoint
/api/v1/ysws_entries

### Response
#### Success Response (200)
- **id** (string) - Airtable record ID
- **ysws** (string) - YSWS program name
- **approved_at** (integer|null) - Unix timestamp of approval
- **code_url** (string|null) - GitHub/code repository URL
- **country** (string|null) - Country of the creator
- **demo_url** (string|null) - Live demo URL
- **description** (string|null) - Project description
- **github_username** (string|null) - GitHub username
- **heard_through** (string|null) - How they heard about YSWS
- **hours** (number|null) - Hours spent on project
- **screenshot_url** (string|null) - Screenshot URL
```

--------------------------------

### GET /api/v1/cached_images/:id

Source: https://ships.hackclub.com/docs

Public endpoint that returns cached image data by Airtable ID.

```APIDOC
## GET /api/v1/cached_images/:id

### Description
Returns cached image data by Airtable ID. This endpoint is public.

### Method
GET

### Endpoint
/api/v1/cached_images/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - Airtable ID

### Response
#### Success Response (200)
- **original_url** (string) - Original image URL
- **cached_url** (string) - Cached/proxied image URL
```
Tokens:
Raw