CouchPotato API Documentation

You can access the API via
{{ fireEvent('app.api_url', single = True)|safe }}/
To see it in action, have a look at the webinterface with Firebug (on firefox) or the development tools included in Chrome. All the data that you see there are from the API.

A normal API call:
{{ fireEvent('app.api_url', single = True)|safe }}/updater.info/

You can also use the API over another domain using JSONP, the callback function should be in 'callback_func'
{{ fireEvent('app.api_url', single = True)|safe }}/updater.info/?callback_func=myfunction


Get the API key:
{{ url_for('web.index') }}getkey/?p=md5(password)&u=md5(username)
Will return {"api_key": "XXXXXXXXXX", "success": true}. When username or password is empty you don't need to md5 it.
{% for route in routes %} {% if api_docs.get(route) %}

{{route}}

{{api_docs[route].get('desc', '')}}
{% if api_docs[route].get('params') %}

Params

{% for param in api_docs[route]['params'] %} {% endfor %}
{{param}} {{ api_docs[route]['params'][param].get('type', 'string') }} {{ api_docs[route]['params'][param]['desc'] }}
{% endif %} {% if api_docs[route].get('return') %}

Return

{{ api_docs[route]['return'].get('type', '{"success": True}') }}
{% if api_docs[route]['return'].get('example') %}

Example

{{ api_docs[route]['return'].get('example', '')|safe }}
{% endif %}
{% endif %}
{% endif %} {% endfor %}

Missing documentation

{{', '.join(api_docs_missing)}}