API
Introduction
You can now connect to the thousands of math news, blog posts and podcasts produced every week using our API thanks to SubjectSeeker, the excellent software behind ScienceSeeker.org.
Jumping right in
You can get a first impression of how to build feeds by looking at the redirects for our old feeds.
- The pure feed
- The applied feed
- The teachers/educators feed
- The visual feed
- The history feed
- The art feed
- The fun feed
- The journalism feed
- The commercial feed
- The researchers feed (pure, applied and history)
- The full feed
Formatting of search parameters in request URI
Base URL: http://beta.mathblogging.org/search/default/
Types
The type of query is specified by the type parameter, with a value of blog, post, or topic:
- ?type=blog
- ?type=post
- ?type=topic
This parameter is required.
Filters
If type is topic, the only other parameter allowed in the query is the toplevel parameter, which must be true. This parameter is optional and does not need to be specified. This specifies that only top-level topics should be returned. Top level topics are the topics which Mathblogging.org will display in its Top Level Topics list.
&filter0=toplevel&value0=true
To request a list of all top-level parameters, the query would be:
http://beta.mathblogging.org/search/default/?type=topic
or
http://beta.mathblogging.org/search/default/?type=topic&filter0=toplevel&value0=true
If type is blog or post:
Following the type parameter must be one or more filter parameters. Each filter parameter is numbered (filter0, filter1, filter2...) to match it with corresponding parameters such as value (value0...) and modifier.
The value of the filter parameter should be the name of the specified filter to apply (corresponding to the name element in the REST API). Each possible filter has other associated parameters. Possible filters are:
topic: select results from blogs/posts with the specified topic associated. Associated parameter: value (the name of the specified topic). For example, to filter on the topic Biology (if type is blog, return all blogs with a Biology topic; if type is post, return all posts with a Biology topic). See the blog filter to search for posts from a blog with a specific blog-level topic.
&filter0=topic&value0=Biology
identifier: Select posts with the specified unique internal identifier in the database, or blogs with the specified identifier, depending on how type was specified. Associated parameters: value (the unique identifier to search, must be numeric only).
&filter0=identifier&value0=7593
title: Select posts with the specified post title, or blogs with the specified blog title, depending on how type was specified. Associated parameters: value (the text of the title to search on) and modifier (default modifier is all, meaning the entire string must match. Alternatively, modifier may be some, meaning only a partial string must match).
&filter0=title&value0=Once+upon+a+time&modifier0=all
summary: Select posts with the specified post summary, or blogs with the specified description, depending on how type was specified. Associated parameters: value (text of summary to search on) and modifier). Default modifier is some (meaning only a partial string must match). Alternatively, modifier may be all (meaning the entire string must match).
&filter0=summary&value0=Once+upon+a+time&modifier0=all
url: Select posts with the specified post URL, or blogs with the specified URL, depending on how type was specified. Associated parameters: value (text of URI to search on) and modifier). Default modifier is some (meaning only a partial string must match). Alternatively, modifier may be all (meaning the entire string must match).
&filter0=url&value0=someblog.blogspot.com
blog: Select posts from blogs with the specified title, identifier, or topic. Note that searching with type=blog is equivalent to using the title or topic queries. Default modifier is title-some (search for posts from blogs whose title contains the specified string). Other modifiers are title-all (search for posts from blogs whose title completely matches the specified string), identifier (search for posts from blogs with the internal Mathblogging.org identifier specified), and topic (search for posts from blogs with the specified top-level topic).
&filter0=blog&modifier0=title-all&value0=Scientifically+Speaking
citation: Select posts with the specified citation. If type is blog, will return 0 results. Associated parameters: modifier (optional) (default id-all; alternatively may be doi, pmid, arxiv, author, article-title or journal-title. The value parameter contains the value of the string to search on; this is always a partial-text search.
&filter0=citation&modifier0=doi&value0=10.1162/jocn.2006.18.11.1947
has-citation: Select posts which have at least one associated citation. If type is blog, will return blogs that have posts with citations. Associated parameters: modifier parameter is optional and only available if filter is set to true and defaults to all, alternatively may be doi, arxiv, pmid or other; and value parameter is optional and defaults to true.
&filter0=has-citation
or
&filter0=has-citation&value0=false
is-recommended: Select posts which have at least one associated recommendation. If type is blog, will return 0 results. The associated value parameter is optional and defaults to true.
&filter0=is-recommended
or
&filter0=is-recommended&value0=false
recommended-by: Select posts which have at least one associated recommendation by a certain user. If type is blog, will return 0 results. The associated value parameter is required and contains the username of the specified user.
&filter0=recommended-by&value0=jphekman
recommender-status: Select posts which have at least one associated recommendation by a user with the specified status or greater status. If type is blog, will return 0 results. The value parameter is optional and defaults to user; may also be editor.
&filter0=recommender-status&value0=editor
min-recommendations: Select posts which have at least the minimum number of associated recommendations. If type is blog, will return 0 results. The value parameter is required and takes a numeric value.
&filter0=min-recommendations&value0=10
Using multiple parameters
To specify multiple filters, increase the number of each filter parameter and its associated parameters. Filters may be specified more than once; if two of the same filter are specified, results matching both filters are returned.
