Skip to main content
POST
/
api
/
pikabu
/
communities
/
search
/pikabu/communities/search
curl --request POST \
  --url https://api.anysite.io/api/pikabu/communities/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "keyword": "<string>",
  "count": 2,
  "timeout": 300
}
'
[
  {
    "@type": "@pikabu_community_result",
    "id": "<string>",
    "name": "<string>",
    "alias": "<string>",
    "image": "<string>",
    "url": "<string>",
    "rules": "<string>",
    "tags": [],
    "story_count": 123,
    "subscriber_count": 123,
    "is_nsfw": false,
    "is_locked": true
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
keyword
string
required

Search keyword

Minimum string length: 1
count
integer
required

Max number of communities to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

@type
string
default:@pikabu_community_result
id
string | null
name
string | null
alias
string | null
image
string | null
url
string | null
rules
string | null
tags
string[]
story_count
integer | null
subscriber_count
integer | null
is_nsfw
boolean
default:false
is_locked
boolean | null