★ <\/a> <\/div>", "summary": null, "url": "http:\/\/weblog.rogueamoeba.com\/2015\/01\/20\/audio-hijack-3-has-arrived\/", "extracted_content_url": "https://extract.feedbin.com/parser/feedbin/9197b49979d10d5012130f8b456bd5bd040d3206?base64_url=aHR0cDovL3d3dy5jcmFpZ2tlcnN0aWVucy5jb20vMjAxNy8wMy8xMi9nZXR0aW5nLXN0YXJ0ZWQtd2l0aC1qc29uYi1pbi1wb3N0Z3Jlcy8=", "published": "2015-01-21T01:34:41.000000Z", "created_at": "2015-01-21T01:37:57.679046Z", "original": { "author": "John Gruber", "content": "
Gorgeous new interface in this major update to Rogue Amoeba’s venerable audio recording app. This is one of the best takes on Yosemite-style design I’ve seen. <\/p>
★ <\/a> <\/div>", "title": "Audio Hijack 3", "url": "http:\/\/weblog.rogueamoeba.com\/2015\/01\/20\/audio-hijack-3-has-arrived\/", "entry_id": "tag:daringfireball.net,2015:/linked//6.30480", "published": "2015-01-21T01:34:41.000Z", "data": null } } ``` -------------------------------- ### Example Feedbin Full Content API Response Source: https://github.com/feedbin/feedbin-api/blob/master/content/extract-full-content.md This JSON object represents the structure of the response received from the Feedbin full content API, containing extracted article details. ```json { "title": "Private by Default", "author": null, "date_published": "2018-09-11T00:00:00.000Z", "dek": null, "lead_image_url": "https://assets.feedbin.com/assets-site/blog/2018-09-11/embed-3f43088538ae5ed7e585c00013adc13a915fd35de31990b3081a085b963ed7dd.png", "content": "
content
", "next_page_url": null, "url": "https://feedbin.com/blog/2018/09/11/private-by-default/", "domain": "feedbin.com", "excerpt": "September 11, 2018 by Ben Ubois I want Feedbin to be the opposite of Big Social. I think people should have the right not to be tracked on the Internet and Feedbin can help facilitate that. Since…", "word_count": 787, "direction": "ltr", "total_pages": 1, "rendered_pages": 1 } ``` -------------------------------- ### Fetch Specific Subscription with Caching Headers Source: https://github.com/feedbin/feedbin-api/blob/master/README.md Retrieves a specific subscription (ID 3) using cURL, demonstrating the use of ETag and Last-Modified headers for HTTP caching. This example shows the response headers returned by the server. ```shell curl -v -u 'example@example.com:password' https://api.feedbin.com/v2/subscriptions/3.json ``` -------------------------------- ### Retrieve Updated Entries with Original Content and Diff Source: https://github.com/feedbin/feedbin-api/blob/master/content/updated-entries.md Use this endpoint to get a list of updated entry IDs. You can then use these IDs with the `entries` API to fetch the original and latest versions of the entries, including a content diff. ```HTTP GET /v2/entries.json?include_original=true&include_content_diff=true&ids=703369824 ``` -------------------------------- ### Get Updated Entries Source: https://github.com/feedbin/feedbin-api/blob/master/content/updated-entries.md Retrieves an array of entry IDs that have been updated. You can optionally filter by a `since` date to get entries updated after a specific ISO 8601 timestamp. ```APIDOC ## GET /v2/updated_entries.json ### Description Retrieves an array of entry IDs that have been updated. ### Method GET ### Endpoint /v2/updated_entries.json ### Parameters #### Query Parameters - **since** (date) - Optional - Filters updated entries to those modified after the provided ISO 8601 timestamp. Example: `?since=2013-02-02T14:07:33.000000Z` ### Response #### Success Response (200) - An array of integer entry IDs. ### Response Example ```json [4087,4088,4089,4090,4091,4092,4093,4094,4095,4096,4097] ``` ``` -------------------------------- ### Fetch All Entries Source: https://github.com/feedbin/feedbin-api/blob/master/content/entries.md Use this command to retrieve a paginated list of all entries for a user. Authentication is required. ```bash curl --request GET --user "example@example.com:password" https://api.feedbin.com/v2/entries.json ``` -------------------------------- ### Get Updated Entries Source: https://github.com/feedbin/feedbin-api/blob/master/content/updated-entries.md Retrieve an array of entry IDs that have been updated. This endpoint can be filtered by a specific date using the `since` parameter to get entries updated after a given ISO 8601 timestamp. ```http GET /v2/updated_entries.json ``` ```http GET /v2/updated_entries.json?since=2013-02-02T14:07:33.000000Z ``` -------------------------------- ### Create New Import Source: https://github.com/feedbin/feedbin-api/blob/master/content/imports.md Use this endpoint to initiate a new import of an OPML file. Ensure the Content-Type header is set to text/xml and the request body contains the XML content. ```bash curl --request POST --user "example@example.com:password" --header "Content-Type: text/xml" --data-binary "@/path/to/subscriptions.xml" https://api.feedbin.com/v2/imports.json ``` -------------------------------- ### Get Tagging Source: https://github.com/feedbin/feedbin-api/blob/master/content/taggings.md Retrieves a specific tagging by its ID. ```APIDOC ## GET /v2/taggings/{id}.json ### Description Retrieves a specific tagging by its ID. ### Method GET ### Endpoint /v2/taggings/{id}.json ### Parameters #### Path Parameters - **id** (number) - Required - The unique identifier of the tagging to retrieve. ### Response #### Success Response (200) - **id** (number) - The unique identifier for the tagging. - **feed_id** (number) - The ID of the feed associated with the tagging. - **name** (string) - The name of the tagging. ### Response Example ```json { "id": 4, "feed_id": 1, "name": "Tech" } ``` ### Error Handling - **403 Forbidden**: Returned if the user does not own this tagging. ``` -------------------------------- ### Get Specific Subscription Source: https://github.com/feedbin/feedbin-api/blob/master/content/subscriptions.md Retrieves a single subscription by its unique identifier. ```APIDOC ## GET /v2/subscriptions/{id}.json ### Description Retrieves a single subscription by its unique identifier. ### Method GET ### Endpoint /v2/subscriptions/{id}.json ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the subscription to retrieve. ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the subscription. - **created_at** (string) - The ISO 8601 timestamp when the subscription was created. - **feed_id** (integer) - The ID of the associated feed. - **title** (string) - The title of the subscription. - **feed_url** (string) - The URL of the feed. - **site_url** (string) - The URL of the website associated with the feed. #### Response Example ```json { "id": 525, "created_at": "2013-03-12T11:30:25.209432Z", "feed_id": 47, "title": "Daring Fireball", "feed_url": "http://daringfireball.net/index.xml", "site_url": "http://daringfireball.net/" } ``` ``` -------------------------------- ### Create Subscription using cURL Source: https://github.com/feedbin/feedbin-api/blob/master/README.md Shows how to create a new subscription using cURL, including setting the Content-Type header and providing JSON data in the request body. Ensure the Content-Type is set to 'application/json; charset=utf-8'. ```shell curl -u 'example@example.com:password' \ -H "Content-Type: application/json; charset=utf-8" \ -X POST -d '{"feed_url":"http://daringfireball.net"}' \ https://api.feedbin.com/v2/subscriptions.json ``` -------------------------------- ### Get Specific Subscription Source: https://github.com/feedbin/feedbin-api/blob/master/content/subscriptions.md Retrieves a single subscription by its unique ID. ```json { "id": 525, "created_at": "2013-03-12T11:30:25.209432Z", "feed_id": 47, "title": "Daring Fireball", "feed_url": "http://daringfireball.net/index.xml", "site_url": "http://daringfireball.net/" } ``` -------------------------------- ### Check Feedbin API Credentials Source: https://github.com/feedbin/feedbin-api/blob/master/content/authentication.md Use this endpoint to verify user credentials by including them via HTTP basic authentication. A 200 OK status indicates valid credentials, while 401 Unauthorized signifies invalid ones. ```bash curl --request GET --user "example@example.com:password" https://api.feedbin.com/v2/authentication.json ``` -------------------------------- ### Get Taggings Source: https://github.com/feedbin/feedbin-api/blob/master/content/taggings.md Retrieves a list of all taggings associated with the authenticated user. ```APIDOC ## GET /v2/taggings.json ### Description Retrieves a list of all taggings. ### Method GET ### Endpoint /v2/taggings.json ### Response #### Success Response (200) - **id** (number) - The unique identifier for the tagging. - **feed_id** (number) - The ID of the feed associated with the tagging. - **name** (string) - The name of the tagging. ### Response Example ```json [ { "id": 4, "feed_id": 1, "name": "Tech" }, { "id": 5, "feed_id": 2, "name": "News" } ] ``` ``` -------------------------------- ### Get Saved Searches Source: https://github.com/feedbin/feedbin-api/blob/master/content/saved-searches.md Retrieves a list of all saved searches for the authenticated user. ```APIDOC ## GET /v2/saved_searches.json ### Description Retrieves a list of all saved searches. ### Method GET ### Endpoint /v2/saved_searches.json ### Parameters #### Query Parameters - **page** (number) - Optional - Used to get a specific page of search results. ### Response #### Success Response (200 OK) - **id** (integer) - The unique identifier for the saved search. - **name** (string) - The name of the saved search. - **query** (string) - The search query string. ### Response Example { "example": "[ { "id": 1, "name": "JavaScript", "query": "javascript is:unread" } ]" } ``` -------------------------------- ### Include Podcast/RSS Enclosure Data Source: https://github.com/feedbin/feedbin-api/blob/master/content/entries.md Append the `include_enclosure` parameter set to `true` to include podcast or RSS enclosure data with the entry. ```http GET /v2/entries.json?include_enclosure=true ``` -------------------------------- ### GET /v2/entries/{entry_id}.json Source: https://github.com/feedbin/feedbin-api/blob/master/content/entries.md Retrieves a single entry object based on its unique ID. ```APIDOC ## GET /v2/entries/{entry_id}.json ### Description Returns a single entry object for a given entry ID. ### Method GET ### Endpoint /v2/entries/{entry_id}.json ### Request Example ```bash curl --request GET --user "example@example.com:password" https://api.feedbin.com/v2/entries/3648.json ``` ### Response #### Success Response (200 OK) Returns a single entry object. #### Response Example ```json { "id": 3648, "feed_id": 203, "title": "Cleveland Drinkup February 6", "url": "https:\/\/github.com\/blog\/1398-cleveland-drinkup-february-6", "extracted_content_url": "https://extract.feedbin.com/parser/feedbin/9197b49979d10d5012130f8b456bd5bd040d3206?base64_url=aHR0cDovL3d3dy5jcmFpZ2tlcnN0aWVucy5jb20vMjAxNy8wMy8xMi9nZXR0aW5nLXN0YXJ0ZWQtd2l0aC1qc29uYi1pbi1wb3N0Z3Jlcy8=", "author": "juliamae", "content": "
Cleveland :metal:! Let's :beers: :cocktail: :neckbeard: :guitar: :octocat: in one of Ohio's greatest cities, Cleveland!
\n
Join @asenchi and me Wednesday at the Great Lakes Brewing Company Taproom, drinks on GitHub.
\n
$\"Great$ The Facts:
\n
\n
Great Lakes Brewing Company - 2516 Market Ave
\n
Wednesday, February 6 at 8:00pm
\n
$\"Screen$
", "summary": null, "published": "2013-02-03T01:00:19.000000Z", "created_at": "2013-02-04T01:00:19.127893Z" } ``` ### Status Codes - `200 OK`: Returned if the entry is found. - `404 Not Found`: Returned if the entry ID does not exist. ``` -------------------------------- ### Retrieving a Specific Subscription with Caching Headers Source: https://github.com/feedbin/feedbin-api/blob/master/README.md Demonstrates retrieving a specific subscription and how to use ETag and Last-Modified headers for caching. ```APIDOC ## GET /subscriptions/{id}.json ### Description Retrieves a specific subscription by its ID. Includes caching headers for efficient requests. ### Method GET ### Endpoint `https://api.feedbin.com/v2/subscriptions/{id}.json` ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the subscription to retrieve. ### Request Example (with caching headers) ```shell curl -v -u 'example@example.com:password' --header 'If-Modified-Since:Sat, 02 Feb 2013 15:20:46 GMT' --header 'If-None-Match:"c7d001e87bda1f0d3745b6bd2811b055"' https://api.feedbin.com/v2/subscriptions/3.json ``` ### Response #### Success Response (200) - **ETag** (string) - The ETag header for caching. - **Last-Modified** (string) - The Last-Modified header for caching. #### Response Example (headers) ``` < ETag: "c7d001e87bda1f0d3745b6bd2811b055" < Last-Modified: Sat, 02 Feb 2013 15:20:46 GMT ``` #### Response Example (304 Not Modified) ``` < HTTP/1.1 304 Not Modified ``` ``` -------------------------------- ### Import Creation Response Source: https://github.com/feedbin/feedbin-api/blob/master/content/imports.md The response to a successful import creation includes an ID for the import, its completion status, creation timestamp, and a list of import items with their initial status. ```json { "id": 6, "complete": false, "created_at": "2019-05-16T20:27:47.038Z", "import_items": [ { "title": "Daring Fireball", "feed_url": "http://daringfireball.net/feeds/main", "status": "pending" } ] } ``` -------------------------------- ### POST /v2/imports.json Source: https://github.com/feedbin/feedbin-api/blob/master/content/imports.md Creates a new import by uploading an OPML file. The request body must be an XML string with the Content-Type header set to text/xml. It returns the import details and the status of each item within the import. ```APIDOC ## POST /v2/imports.json ### Description Create a new import. The POST body should be an XML string. Returns the import along with the status of each of the import_items. The `Content-Type` header must be set to `text/xml`. ### Method POST ### Endpoint https://api.feedbin.com/v2/imports.json ### Parameters #### Request Body - **XML String** (string) - Required - The OPML file content. ### Request Example ```bash curl --request POST --user "example@example.com:password" --header "Content-Type: text/xml" --data-binary "@/path/to/subscriptions.xml" https://api.feedbin.com/v2/imports.json ``` ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the import. - **complete** (boolean) - Indicates if the import process is fully completed. - **created_at** (string) - The timestamp when the import was created. - **import_items** (array) - A list of items included in the import. - **title** (string) - The title of the feed. - **feed_url** (string) - The URL of the feed. - **status** (string) - The status of the import item (`pending`, `complete`, `failed`). #### Response Example ```json { "id": 6, "complete": false, "created_at": "2019-05-16T20:27:47.038Z", "import_items": [ { "title": "Daring Fireball", "feed_url": "http://daringfireball.net/feeds/main", "status": "pending" } ] } ``` ``` -------------------------------- ### Get Recently Read Entries Source: https://github.com/feedbin/feedbin-api/blob/master/content/recently-read-entries.md Retrieves an array of entry IDs for recently read entries. ```APIDOC ## GET /v2/recently_read_entries.json ### Description Returns an array of entry_ids for recently read entries. ### Method GET ### Endpoint /v2/recently_read_entries.json ### Response #### Success Response (200 OK) - An array of entry_ids (integer). ### Response Example ```json [4087,4088,4089,4090,4091,4092,4093,4094,4095,4096,4097] ``` ### Note The order of IDs is the order these should be displayed in. ``` -------------------------------- ### Paginated Entries Source: https://github.com/feedbin/feedbin-api/blob/master/README.md Explains how pagination works for resources like entries, including link headers and record count. ```APIDOC ## GET /feeds/{id}/entries.json (Paginated) ### Description Retrieves paginated entries for a specific feed. ### Method GET ### Endpoint `https://api.feedbin.com/v2/feeds/{id}/entries.json` ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the feed. #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. ### Response #### Headers - **Links** (string) - Contains links to the first, previous, next, and last pages of results. - **X-Feedbin-Record-Count** (integer) - The total number of records for the resource. ### Response Example (Links Header) ``` Links: ; rel="next", ; rel="last" ``` ``` -------------------------------- ### Get All Subscriptions Source: https://github.com/feedbin/feedbin-api/blob/master/content/subscriptions.md Retrieves all subscriptions for the authenticated user. Supports filtering by creation date and expanding feed metadata. ```APIDOC ## GET /v2/subscriptions.json ### Description Retrieves all subscriptions for the authenticated user. Supports filtering by creation date and expanding feed metadata. ### Method GET ### Endpoint /v2/subscriptions.json ### Query Parameters - **since** (date) - Optional - Filters subscriptions created after the specified ISO 8601 timestamp. - **mode** (enum) - Optional - Specifies the output mode. Currently, only `extended` is available, which includes additional feed metadata. ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the subscription. - **created_at** (string) - The ISO 8601 timestamp when the subscription was created. - **feed_id** (integer) - The ID of the associated feed. - **title** (string) - The title of the subscription. - **feed_url** (string) - The URL of the feed. - **site_url** (string) - The URL of the website associated with the feed. #### Response Example ```json [ { "id": 525, "created_at": "2013-03-12T11:30:25.209432Z", "feed_id": 47, "title": "Daring Fireball", "feed_url": "http://daringfireball.net/index.xml", "site_url": "http://daringfireball.net/" } ] ``` **Status Codes** - 200 OK: Returned if subscriptions are found. - 403 Forbidden: Returned if the user does not own the subscription. ``` -------------------------------- ### Filter Entries by Starred Status Source: https://github.com/feedbin/feedbin-api/blob/master/content/entries.md Use the `starred` parameter to filter entries. Set to `true` to get only starred entries. ```http GET /v2/entries.json?starred=true ```