Currents
Category Feed

categories

Server

List subscribed categories

GET
https://api.dev.currentsplatform.com
/v1/categories

Return every category this subscriber holds, newest first. A category that is still warming carries the time its topics become available in ready_at; one that has been archived carries the reason it was archived. Fetch a category by name for its topics.

List subscribed categories › Responses

OK

category
​string · required
status
​string · enum · required
Enum values:
warming
ready
archived
subscribed_at
​string · date-time · required
​
​

Absent once the category is archived: no edition follows.

​

Present only when status is archived.


Subscribe to a category

POST
https://api.dev.currentsplatform.com
/v1/categories

Register a category and begin tracking it. The subscription is accepted immediately and starts warming; its topics become available at the time given in ready_at. Subscribing again to a category you already hold updates its brief, which narrows the topics returned to those closest to what you sell.

Subscribe to a category › Request Body

category
​string · minLength: 1 · maxLength: 100 · required
​

Subscribe to a category › Responses

Accepted

category
​string · required
status
​string · enum · required
Enum values:
warming
ready
archived
​

Fetch a category's topics

GET
https://api.dev.currentsplatform.com
/v1/categories/{category}

Return the category's current topics, each with its trajectory, biddable terms, audience mood, format mix and evidence. A category that is still warming returns no topics yet. The edition is rebuilt every 24 hours; prepared_at and next_update_at bound the one you are reading. A category you have archived carries only its status and the reason it was archived; subscribe to it again to resume tracking and receive topics.

Fetch a category's topics › path Parameters

category
​string · required

Fetch a category's topics › Responses

OK

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: category, prepared_at, next_update_at +3 more
type = object · status="archived" · requires: archive_reason
Properties for CategoryFeed:
category
​string · required
status
​string · enum · required
Enum values:
warming
ready
prepared_at
​string · date-time · required
next_update_at
​string · date-time · required
​Taxonomy · required
​Highlights · required
​Topic[] · required

Ordered by attention_index descending. When the subscription carries a brief, ordered by relevance to the brief instead, with the least relevant topics left out.

​

Archive a category

DELETE
https://api.dev.currentsplatform.com
/v1/categories/{category}

Stop tracking a category for this subscriber. A reason is required.

Archive a category › path Parameters

category
​string · required

Archive a category › query Parameters

reason
​string · minLength: 1 · maxLength: 500 · required

Why the category is being archived. Returned on later fetches.

Why the category is being archived. Returned on later fetches.

Archive a category › Responses

No Content

No data returned