{% extends "crashstats_base.html" %} {% block page_title %}API Documentation{% endblock %} {% block product_nav_filter %} {% endblock %} {% block site_css %} {{ super() }} {% endblock %} {% block site_js %} {{ super() }} {% compress js %} {% endcompress %} {% endblock %} {% block content %}

API Documentation

These API endpoints are publicly available. The parameters to some endpoints are non-trivial as some might require deeper understanding of the Soccoro backend.

Note: All Personal Identifiable Information will be removed or scrubbed from all responses.

{% for endpoint in endpoints %}

{{ endpoint.name }}

{{ ' | '.join(endpoint.methods) }} {{ base_url }}{{ endpoint.url }}

{% if endpoint.docstring %}

Documentation notes

{{ endpoint.docstring }}
{% endif %} {% if endpoint.parameters %} {% for parameter in endpoint.parameters %} {% endfor %}
Parameter key Required? Type Default Test drive
{{ parameter.name }} {% if parameter.required %}Required {% else %}Optional {% endif %} {{ describe_friendly_type(parameter['type']) }} {{ endpoint['defaults'].get(parameter['name'], '') }} {{ make_test_input(parameter, endpoint['defaults']) }}
{% else %}

Takes no parameters

{% endif %}
Loading...

An error happened on the server when trying this URL.

Using

Status

Output:



          
{% endfor %}
{% endblock %}