{% load static %} {{ api_name }}
< back to index {#

#}

HTTP request

{{ get_or_post }} {{ url_root }}/apis/v1/{{ api_slug }} (Jump to "Try It Now")

{% if required_query_parameter_list %}

Required Parameters

{% for query_parameter in required_query_parameter_list %} {% endfor %}
Parameter name Value Description
{{ query_parameter.name }} {{ query_parameter.value }} {{ query_parameter.description }}
{% endif %} {% if optional_query_parameter_list %}

Optional Parameters

{% for query_parameter in optional_query_parameter_list %} {% endfor %}
Parameter name Value Description
{{ query_parameter.name }} {{ query_parameter.value }} {{ query_parameter.description }}
{% endif %} {% if request_body %}

Request body

{{ request_body }} {% endif %}

Response

{{ api_response_notes }}

{{ api_response }}
{% if potential_status_codes_list %}

Response Status Codes

{% for status_code in potential_status_codes_list %} {% endfor %}
Code Description
{{ status_code.code }} {{ status_code.description }}
{% endif %}

Try It Now: API Variables

{{ api_introduction|safe }} {% if get_or_post == "GET or POST" or get_or_post_selected == "GET" or get_or_post_selected == "POST" %}
{% if get_or_post_selected == "POST" %}POST{% else %}GET{% endif %}: Switch from {% if get_or_post_selected == "POST" %}POST TO GET{% else %}GET to POST{% endif %} {% endif %} {% load template_filters %}

{% csrf_token %} {% for query_parameter in required_query_parameter_list %} {% if query_parameter.name != 'api_key' %} {% if query_parameter.value == 'string' or query_parameter.value == 'integer' or query_parameter.value == 'long' %} {% elif query_parameter.value == 'integerlist' %} {% elif query_parameter.value == 'boolean' %} {% endif %} {% endif %} {% endfor %} {% for query_parameter in optional_query_parameter_list %} {% if query_parameter.name != 'api_key' %} {% if query_parameter.value == 'string' or query_parameter.value == 'integer' or query_parameter.value == 'long' %} {% elif query_parameter.value == 'integerlist' %} {% elif query_parameter.value == 'boolean' %} {% elif query_parameter.value == 'text' %} {% endif %} {% endif %} {% endfor %}
Parameter name Value  
{{ query_parameter.name }}:
{{ query_parameter.name }}:
{{ query_parameter.name }}: True
False
{{ query_parameter.name }}:
{{ query_parameter.name }}:
{{ query_parameter.name }}: True
False
{{ query_parameter.name }}:

(opens in new window)