PTT API
Taiwan’s largest BBS (Bulletin Board System) — boards, posts, and search.
- Boards: Browse by board name (e.g.
Gossiping,Stock,NBA) - Posts: Full post content with pushes (comments)
- Search: Search posts within a board
Boards
GET /ptt/boards/:boardName — 1 credit
Get PTT board info by name.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
boardName | string | Yes | — | Board name (e.g. Gossiping, Stock) |
cURL
curl -H "x-api-key: sk_byc_xxx" \
https://api.bycrawl.com/ptt/boards/GossipingResponse
{
"name": "Gossiping",
"title": "批踢踢實業坊",
"url": "https://www.ptt.cc/bbs/Gossiping/index.html"
}GET /ptt/boards/:boardName/posts — 2 credits
Get posts from a PTT board.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
boardName | string | Yes | — | Board name |
page | integer | No | — | Page number (from PTT index). Omit for latest. |
count | integer | No | 20 | Number of posts (max 40) |
cURL
curl -H "x-api-key: sk_byc_xxx" \
"https://api.bycrawl.com/ptt/boards/Gossiping/posts?count=10"Response
{
"board": "Gossiping",
"posts": [
{
"title": "[問卦] 有沒有PTT的八卦",
"author": "example_user",
"date": "3/16",
"url": "https://www.ptt.cc/bbs/Gossiping/M.1773638913.A.077.html",
"pushCount": "10"
}
],
"prevPage": "https://www.ptt.cc/bbs/Gossiping/index38943.html",
"nextPage": null
}Posts
GET /ptt/posts — 2 credits
Get a PTT post by URL with full content and pushes.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | Yes | — | Full PTT post URL or path (e.g. /bbs/Gossiping/M.1773638913.A.077.html) |
cURL
curl -H "x-api-key: sk_byc_xxx" \
"https://api.bycrawl.com/ptt/posts?url=/bbs/Gossiping/M.1773638913.A.077.html"Response
{
"id": "M.1773638913.A.077",
"title": "[問卦] 有沒有PTT的八卦",
"author": "example_user (暱稱)",
"board": "Gossiping",
"datetime": "Mon Mar 16 13:28:31 2026",
"content": "文章內容...",
"url": "https://www.ptt.cc/bbs/Gossiping/M.1773638913.A.077.html",
"pushes": [
{
"type": "push",
"author": "user1",
"content": "推文內容",
"datetime": "03/16 13:30"
}
],
"pushSummary": {
"push": 10,
"boo": 2,
"arrow": 5,
"total": 17
}
}Search
GET /ptt/boards/:boardName/search — 2 credits
Search posts in a PTT board.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
boardName | string | Yes | — | Board name |
q | string | Yes | — | Search query |
count | integer | No | 20 | Number of results (max 40) |
cURL
curl -H "x-api-key: sk_byc_xxx" \
"https://api.bycrawl.com/ptt/boards/Gossiping/search?q=台積電&count=10"Response
{
"board": "Gossiping",
"posts": [
{
"title": "[新聞] 台積電法說會重點整理",
"author": "stock_user",
"date": "3/15",
"url": "https://www.ptt.cc/bbs/Gossiping/M.1773552000.A.123.html",
"pushCount": "55"
}
],
"prevPage": null,
"nextPage": null
}