contents of this page
API Reference¶
The root URL for all Parse.ly API requests is:
http://api.parse.ly/v1
If you try to open http://api.parse.ly in a browser, you’re just going to hit a landing page. Each of our REST resources (as described from a high level in our Concepts document) is exposed as a URL below this root.
Exposed URLs¶
To keep things nice and organized, we have identified all the URLs exposed by our API in terms of a lightweight grammar.
Note
This grammar uses a subset of Perl, including string literal (”...”), string concatenation (.), and regex literal syntax (/.../). The named capturing groups use the PCRE syntax of (?P<param>...), where ... is a regular expression and param is the name of the capturing group. These named capture groups are distinct parameters passed along to our API.
The following are all the URLs exposed by the API.
# recommended items for a user profile
/^profile/(?P<profile_id>[^/]*)/recommended$/
# user's past visits
/^profile/(?P<profile_id>[^/]*)/visits$/
# full user profile
/^profile/(?P<_id>[^/]*)$/
# related items or topics for a given item by URL
/^item-by-url/(?P<action>related|topics)$/
# related items or topics for a given item by ID
/^item/(?P<item_id>[^/]*)/(?P<action>related|topics)$/
The best way to play around with the API is to use the JavaScript API.