Skip to main content

Artemis API Documentation

You can use the Artemis API to:

  1. Retrieve all posts in your feed.
  2. Retrieve posts in your feed that match one or more conditions.

Retrieve All Posts

Send a GET request to your API endpoint:

https://artemis.jamesg.blog/api?token=your_api_key

Replace your_api_key with your API key.

This will return a list of the first 10 posts in your feed. Each post will have five keys:

  • domain: The post domain.
  • title: The post's title.
  • as2: As ActivityStreams 2 representation of the post, with the full post content.
  • published: The post's publication date.
  • url: The post's URL.

To retrieve more than 10 posts, you can use the start= parameter.

This parameter allows you to get posts starting from a specific index.

For example, to get posts 10-20, you could use:

&start=10

Filter Results

You can filter results by:

  • Keyword in title.
  • Domain.
  • Author ID.

Artemis does not support full text search of posts in your reader.

By keyword in title

You can filter posts that match one or more conditions.

You can do so by adding a q query string parameter to your search request.

The q value can contain:

  • Single or multiple words or phrases.
  • Terms prefixed with a dash to exclude posts that contain the term.

For example, you could use the following expression to find all posts that contain "diner coffee" but not pancakes:

&q="diner coffee" -pancakes

By domain

You can filter posts by the domain of the post entry using the ?domain= parameter.

By author ID

You can filter posts by the domain of the post entry using the ?author= parameter.

To use this filter, you need to retrieve the author ID of a feed from your Artemis dashboard.

To find this information, go to your Authors list, then click Edit on the author to whose feed you want to scope your search.

Copy the "Author ID" on the page. You can then use that ID in the ?author= parameter.