Get Search / Hey.Café Endpoint Docs

Public

get_search_accounts

Searches the system for accounts based on a query. This will search accounts for a matching single string within the alias, or name.

Primary URL: https://endpoint.hey.cafe/get_search_accountsAlias URL: https://endpoint.hey.cafe/api/search_accounts

base64Required

search

The search query.

text

search_raw

You can use this if you want to provide the text without encoding.

number

count

Number of items to show.

number

start

Offset for search results.

text

cafe

If you provide a café name or ID we will only show a result if they are related in some way to that café if you are a member of the café only.

boolean

following

Allows you to limit what is searched.

Public

get_search_cafes

Searches the system for cafés based on a query. This will search cafés for a matching single string within the alias, or name.

Primary URL: https://endpoint.hey.cafe/get_search_cafesAlias URL: https://endpoint.hey.cafe/api/search_cafes

base64Required

search

The search query.

text

search_raw

You can use this if you want to provide the text without encoding.

number

count

Number of items to show.

number

start

Offset for search results.

boolean

member

Allows you to limit what is searched.

Public

Searches the system for conversations based on a query. You can use a space like 'pokemon fan' to search for any use of 'pokemon' and the word 'fan' even when content is between. It also can search down to accounts or cafès by using '@hey' or '!pokemon' to only show content posted by that account or in that café. You can also multi search separate matches in one result by putting each search term inside [] for example to find all shared youtube video formats you can search for [https://youtube.com watch] [https://youtube.com live] [https://youtu.be].

Primary URL: https://endpoint.hey.cafe/get_search_conversationsAlias URL: https://endpoint.hey.cafe/api/search_conversations

base64Required

search

The search query.

text

search_raw

You can use this if you want to provide the text without encoding.

number

count

Number of items to show.

number

start

Offset for search results.

boolean

following

If using an account API token if provided as TRUE we will only search content from accounts being followed by the API account.

text

order

Change the search index key order from by weight to by item date, allowing you to always fetch the most recent result for each word break in the query even if not the best item score. Values are 'weight' and 'date' with the option weight being default.

boolean

direct

If set to true you can only use this with SINGLE word break searches like for example 'attach:image' type queries or 'bird' and it will fetch direct match within the same limit from the search key table as what will be returned from the conversations table. Good for loading all a conversations with something specific going further back than default search will let you.

Public

get_search_comments

Searches the system for comments based on a query. You can use a space like 'pokemon fan' to search for any use of 'pokemon' and the word 'fan' even when content is between. It also can search down to accounts or cafès by using '@hey' or '!pokemon' to only show content posted by that account or in that café. You can also multi search separate matches in one result by putting each search term inside [] for example to find all shared youtube video formats you can search for [https://youtube.com watch] [https://youtube.com live] [https://youtu.be].

Primary URL: https://endpoint.hey.cafe/get_search_commentsAlias URL: https://endpoint.hey.cafe/api/search_comments

base64Required

search

The search query.

text

search_raw

You can use this if you want to provide the text without encoding.

number

count

Number of items to show.

number

start

Offset for search results.

boolean

following

If using an account API token if provided as TRUE we will only search content from accounts being followed by the API account.

text

order

boolean

direct

Requires Token

get_search_web

Get search results from the web, powered by Brave at this time without AI results.

Primary URL: https://endpoint.hey.cafe/get_search_web

base64Required

search

The search query.

text

search_raw

You can use this if you want to provide the text without encoding.