/v1/stickers/search
— Search stickers
Returns the most relevant pack for the term, with a link for each sticker. With rotate=true, each call returns the next pack, so bots don't repeat the same result. A term never searched before may come right away with partial=true, with what we already have, while the full search finishes.
| parameter | in | type | description |
|---|---|---|---|
| q | query | string | Search term, 2 to 80 characters. Without it, the response has 30 featured stickers, drawn on every call, with trending=true. |
| X-End-User-Id | header | string | Scale plan: identifies the user on your platform, so the limit applies per user and not to the account. Use a stable id, preferably a hash. |
| max_wait_ms | query | integer | Longest wait for a term never searched before, 0 to 15000 ms. Past that, the response returns right away with pending=true and the search continues: repeat the call shortly. Without it, waits for the result. |
| limit | query | integer | Stickers per response, 1 to 30. Defaults to 30. |
| type | query | string | all, animated or static. Defaults to all. |
| page | query | integer | Pack position in the ranking, starting at 1. Defaults to 1. |
| rotate | query | boolean | true returns the next pack on each call from this account. Ignores page. |
curl "https://flye.win/v1/stickers/search?q=gato&max_wait_ms=300&limit=10" \ -H "Authorization: Bearer $FLYE_KEY"
response · 200
{
"query": "gato",
"total_packs": 12,
"pack": {
"id": "pk_3f9a1c7e2b8d4a60c1e5",
"name": "Gatos engraçados",
"author": "Ana",
"animated": true,
"count": 30
},
"stickers": [
{
"id": "8e1f0c3ab94d27f6a5c1e08d7b3f4a12",
"url": "https://flye.win/media/stickers/8e1f0c3ab94d27f6a5c1e08d7b3f4a12.webp",
"format": "webp",
"animated": true
}
]
}