Basic FoolFuuka
GET Return post
Returns the post object
GET /post/
Required parameters
Name /type | Description /example | Constraints |
---|---|---|
board | Board shortname "plebs" | |
num | Number of the post. 1 |
cURL
curl -X GET "http://archive.4plebs.org/_/api/chan/post/?board=plebs&num=1" \
Response
{ "doc_id": "1", "num": "1", "subnum": "0", "thread_num": "1", "op": "1", "timestamp": "1366825828", "timestamp_expired": "0", "capcode": "N", "email": null, "name": "Anonymous", "trip": null, "title": null, "comment": "4plebs?", "poster_hash": null, "poster_country": null, "sticky": "0", "locked": "0", "deleted": "0", "nreplies": null, "nimages": null, "fourchan_date": "4/24/13(Wed)13:50", "comment_sanitized": "4plebs?", "comment_processed": "4plebs?", "formatted": false, "title_processed": null, "name_processed": "Anonymous", "email_processed": null, "trip_processed": null, "poster_hash_processed": null, "poster_country_name": false, "poster_country_name_processed": "", "media": { "media_id": "1", "spoiler": "0", "preview_orig": "13668258289537s.jpg", "media": "13668215782696.jpg", "preview_op": "13668258289537s.jpg", "preview_reply": null, "preview_w": "209", "preview_h": "250", "media_filename": "feelcup.jpg", "media_w": "645", "media_h": "773", "media_size": "51338", "media_hash": "UGaaniyM723FBlG4b77z/w==", "media_orig": "13668215782696.jpg", "exif": "{\"FileName\":\"d4c564ed648381f49af029c9443de206.jpg\",\"FileDateTime\":1366825827,\"FileSize\":51338,\"FileType\":2,\"MimeType\":\"image\\/jpeg\",\"SectionsFound\":\"\",\"COMPUTED\":{\"html\":\"width=\\\"645\\\" height=\\\"773\\\"\",\"Height\":773,\"Width\":645,\"IsColor\":1}}", "total": "2", "banned": "0", "media_status": "normal", "safe_media_hash": "UGaaniyM723FBlG4b77z_w", "remote_media_link": null, "media_link": "http://img.4plebs.org/boards/plebs/image/1366/82/13668215782696.jpg", "thumb_link": "http://img.4plebs.org/boards/plebs/thumb/1366/82/13668258289537s.jpg", "media_filename_processed": "feelcup.jpg" }, "board": { "name": "4plebs discussion", "shortname": "plebs" } }
GET Return thread
Returns the thread object
GET /thread/
Required parameters
Name /type | Description /example | Constraints |
---|---|---|
board | Board shortname "plebs" | |
num | Number of the thread 1 |
cURL
curl -X GET "http://archive.4plebs.org/_/api/chan/thread/?board=plebs&num=1" \
Response
{ "1": { "op": { // post object // }, "posts": { "1_7": { // post object // }, "1_8": { // post object // } } } }
GET Return board index
Returns the board index
GET /index/
Required parameters
Name /type | Description /example | Constraints |
---|---|---|
board | Board shortname "plebs" | |
page | Page number 1 |
Optional parameters
Name /type | Description /example | Constraints |
---|---|---|
order | Page order "by_thread" |
|
cURL
curl -X GET "http://archive.4plebs.org/_/api/chan/index/?board=plebs&page=1&order=by_thread" \
Response
{ "1145": { "omitted": 0, "images_omitted": 0, "op": { // post object // }, "posts": [ // post objects // ] }, "1148": { "omitted": 0, "images_omitted": 0, "op": { // post object // }, "posts": [ // post objects // ] }, // ... // }
GET Search function
Returns search results. Search API is limited to 5 requests per minute. Other end points aren't limited.
GET /search/
Optional parameters
Name /type | Description /example | Constraints |
---|---|---|
start | Start date. Format: YYYY-MM-DD. "" | |
filename | "" | |
subject | "" | |
text | "" | |
boards | Board shortname. Dot delimiter for multiple. "adv.trv" | |
order | Order of posts. "asc" |
|
ghost | Ghost posts. "none" |
|
uid | "" | |
tripcode | "" | |
username | "" | |
country | "" | |
results | Results grouped by thread or none. "" |
|
filter | Filter. "image" |
|
deleted | Deleted or not. "not-deleted" |
|
type | Post type. "posts" |
|
end | End date. Format: YYYY-MM-DD. "" | |
image | Base64 encoded md5 hash of media file. "" | |
email | "" | |
capcode | Capcode. "user" |
|
cURL
curl -X GET "http://archive.4plebs.org/_/api/chan/search/?boards=adv.trv&email=&username=&tripcode=&capcode=user&subject=&text=&uid=&country=&filename=&image=&deleted=not-deleted&ghost=none&filter=image&type=posts&start=&end=&results=&order=asc" \
Response
{ "0": { "posts": [ { // post object // }, { // post object // }, // ... // ] }, "meta": { "total_found": 3681872, "max_results": 5000, "search_title": "Searching for posts that has not been deleted and that are not by ghosts and that are only non-OP posts and that do not contain images and that were made by users and in ascending order." } }