Straight-street.com API 0.1.0

This is the RESTful API for the straight-street.com symbol set. It allows programs to search for and access symbols as users can do using the interactive gallery web page.

A test web app is available for exploring the api and provides an example of javascript client-side access.

Specification

All symbols have a name and may have multiple tags associated with them. Names and tag names may contain spaces.

API URL base = http://straight-street.com/api/
symbols/ENall english symbols - inludes links to the symbols themselves
symbols/EN/{tokens}symbols (and related tags) with a name or tag that includes 'tokens' (1 or more space separated)
symbol/EN/{name}single symbol with name of 'name'
tags/ENall tags
tags/EN/{tokens}all tags (and related symbols) with name 'tokens' or attached to symbols with 'tokens' in their name
tag/EN/{name}single tag of name
usageusage information - this page
?appid=example.comrequired application id e.g. domain. 5 to 25 characters (a letter followed by letters or digits).
If missing then '401 Unauthorised' is returned
?callback=funcOptional function call support for cross domain access (AKA JSONP)
Paging control - when large numbers of items returned - e.g symbols
symbols/EN/{page}optional page number 'page' of 15 symbols. 1st page and default when not specified is 0
symbols/EN/{page}/{pagesize}optional page number 'page' of 'pagesize' symbols. Max is 20, default is 15
?page=nAlternative for page number. Above syntax is prefered.
?pagesize=nAlternative for page size. Above syntax is prefered

Responses are JSON (mime type "application/json") and to interactively explore them you can use the JSONView Firefox add-on or view them with the JSON Formatter web service. Some items include the related symbol or tag names plus associated URLs into the api. The URLs for several formats of the symbol image are also returned. When an item is not found an empty JSON object is returned rather than HTTP 404. A 404 is returned for invalid URIs.

Examples

The following links demostrate the API (appid is not shown for simplicity).

Known issues

None.