Skip to main content

API Reference

Base URL: https://twixb.com/api/v1 All requests require the X-API-Key header. See Authentication for details.

Endpoints

Newsfeeds

MethodEndpointDescription
GET/v1/newsfeedsList newsfeeds
POST/v1/newsfeedsCreate newsfeed
GET/v1/newsfeeds/{id}Get newsfeed
PUT/v1/newsfeeds/{id}Update newsfeed
DELETE/v1/newsfeeds/{id}Delete newsfeed

Sources

MethodEndpointDescription
GET/v1/sources/{newsfeed_id}List sources
POST/v1/sources/{newsfeed_id}Add source
POST/v1/sources/validateValidate source URL
DELETE/v1/sources/{source_id}Delete source

Posts

MethodEndpointDescription
GET/v1/posts/newsfeed/{newsfeed_id}List posts
GET/v1/posts/{post_id}Get post
PUT/v1/posts/{post_id}/readMark read
PUT/v1/posts/{post_id}/unreadMark unread
PUT/v1/posts/{post_id}/hideHide post

Lists

MethodEndpointDescription
GET/v1/listsList all lists
POST/v1/listsCreate list
GET/v1/lists/{list_id}Get list
POST/v1/lists/{list_id}/itemsAdd to list
DELETE/v1/lists/{list_id}/items/{post_id}Remove from list