Api references

Browse content

introduction

Our service is simple and easy to use.

We don't have any authentication (mostly), and we have only a few entities.

Just follow the example section below, and see how easy it.

any sentence from the series. are present as "Sentence" entity.

Each one have the following attributes (the attribute type are present as python type):

content, [str]: the text that are spoken in the time.
id, [int]: a unique id, mostly by chronology order.
position, [dict]: an object that include the following data about the position of the sentence in the series:
- season, [int]: tne number of the season, that the sentence appears.
- episode, [int]: the number of the episode from the season.
- start, [datetime]: time the sentence are start to be spoken.
- end, [datetime]: the end-time of the sentence.
language, [dict]: an object that include the following data about the sentence language:
- language_code, [str]: one of the Supported languages, based on the languages-code's list. e.g.: en, he, etc.
- language_name: the most known name of the language, such as English, Hebrew, etc.
details, [dict]: an object that include the following data about the 'community' details of the sentence:
- likes, [int]: count of times people react the sentence, by the api, bot or the site.
- verified, [bool]: true, if the content of the sentence was verified by us. see more at report-problems.
- [ ] views, [int]: count of times people saw this sentence. #TODO

All this information is return by sample request:

$ wget -O data.json https://api.friends-search.com/sentence/<id>

this command will create a file name data.json with all the information presented above. for example:

for more examples of usage, see the Examples section below.

The Sentence object are support the following methods:

search: of course, see Search sentences.
like: mark the sentence as "liked". it does not require any login or other oath methode.
[ ] view: mark the sentence as "views".
report: report a sentence content.
[ ] edit: edit and correct the sentence content. this method require an admin permissions.
[ ] verify: verify the sentence content. this method also require an admin permissions.

Read more about the three last methods at Report problems section below.

You can get a list of all the supported languages. All these languages are fully supported, in the Database, the Website and the Telegram bot.

Get the list, simply by request to:

$ wget https://api.friends-search.com/language

The response will look like:

{
  "ok": true, 
  "results": {
    "ag": "All languages", 
    "en": "English", 
    "fr": "Français", 
    "he": "עברית"
  }
}

if you want to check if any language is supported, you can GET the query in the url, such as:

$ wget https://api.friends-search.com/language/en

The request above will return the following response:

{
  "ok": true
}

When a language is not supported yet, you will get #TODO

NOTE: the ag language are present All languages and intended for internal use.

Of course, you can search sentence... that why we came here.