Read the Docs Public API¶
We have a limited public API that is available for you to get data out of the site. This document covers only part of the API provided. We have plans to create a read/write API, so that you can easily automate interactions with your project.
Warning
This API is out of date and not currently maintained. We have a v2 API that is currently supported at http://readthedocs.org/api/v2/.
A basic API client using slumber¶
You can use Slumber to build basic API wrappers in python. Here is a simple example of using slumber to interact with the RTD API:
from __future__ import print_function
import slumber
import json
show_objs = True
api = slumber.API(base_url='http://readthedocs.org/api/v1/')
val = api.project.get(slug='pip')
if show_objs:
for obj in val['objects']:
print(json.dumps(obj, indent=4))
else:
print(json.dumps(val, indent=4))
Alternatively you can try with the following value:
# fetch project pip without metadata.
val = api.project('pip').get()
# get a specific build
val = api.build(2592228).get()
# get the build of a specific project.
val = api.build.get(project__slug='read-the-docs')
# get a specific user by `username`
val = api.user.get(username='eric')
#val = api.version('pip').get()
#val = api.version('pip').get(slug='1.0.1')
API Endpoints¶
Feel free to use cURL and python to look at formatted json examples. You can also look at them in your browser, if it handles returned json.
curl http://readthedocs.org/api/v1/project/pip/?format=json | python -m json.tool