Feedly API Essential Guide

What type of API does Feedly provide?

Feedly has a REST API.

Here are the key points about Feedly's API:

1. It is a REST API that allows developers to automate workflows and integrate Feedly functionality into other applications.

2. The API uses HTTPS and is accessed from the api.feedly.com domain.

3. It follows RESTful conventions, with most operations performed via GET, POST, and DELETE requests on endpoints.

4. Request and response bodies are encoded as JSON.

5. All timestamps are returned as long EPOCH values in milliseconds.

6. To use the API, developers need to generate an API Access Token from their Feedly account.

Some best practices for using Feedly's REST API include:

• Use HTTPS for all API calls to ensure security
• Include the API Access Token in the Authorization header
• Follow RESTful principles when making requests
• Parse JSON responses appropriately
• Handle timestamps as EPOCH millisecond values

In summary, Feedly provides a standard REST API that allows developers to integrate with and extend Feedly's functionality in a secure and standardized way. The REST architecture makes it relatively straightforward to use compared to alternatives like SOAP or GraphQL.

Does the Feedly API have webhooks?

Webhook Support

Yes, the official Feedly API does support webhooks.

Types of Events

The Feedly API allows you to subscribe to the following types of webhook events:

1. NewEntrySaved - Triggered when a new entry is saved to a specific tag or resource.
2. NewAnnotation - Triggered when a new annotation is added.
3. NewWebAlertEntry - Triggered when a new AI feed entry is found.
4. NewEntryPrioritized - Triggered when an entry is prioritized.

Key Points to Consider

• Webhooks must use HTTPS and point to a publicly available server.
• You can optionally provide an authorization header for the webhook URL.
• Webhooks can be created, updated, and deleted through the API.
• You can retrieve a list of existing webhooks.
• Webhooks can be disabled if needed.
• The API provides information about the last successful and failed webhook attempts, including timestamps and error messages.

Creating a Webhook

To create or update a webhook, you need to send a POST request to the following endpoint:

https://api.feedly.com/v3/enterprise/triggers

The request body should include details such as the event type, webhook URL, authorization (if required), and the resource ID to monitor.

Best Practices

1. Always use HTTPS for webhook URLs to ensure security.
2. Monitor the error count and last error messages for your webhooks to ensure they're functioning correctly.
3. Consider using the optional authorization header to secure your webhook endpoints.
4. Be prepared to handle retries and potential duplicate events in your webhook handler.
5. Use the disabled flag to temporarily stop webhook notifications if needed, rather than deleting the webhook entirely.

Rate Limits and other limitations

Based on the search results provided, here are the key points regarding the API Rate Limits of the Feedly API:

Rate Limit Details

• The Feedly plan includes up to 100,000 requests per month [1].
• Access tokens have a limit of 100,000 API requests per month [2].

Rate Limit Tracking

• Feedly Cloud keeps track of how many API requests are performed daily with an access token [2].
• Each API response includes headers that indicate the current rate limit usage:
  • "X-Ratelimit-Count" shows how many API requests have been made so far [2].
  • "X-Ratelimit-Reset" indicates the time left before the counter resets (in seconds) [2].

Example Response Headers

X-Ratelimit-Count: 57
X-Ratelimit-Reset: 23841

This example indicates that 57 API requests have been made so far, and the counter will reset in 6 hours, 37 minutes, and 21 seconds [2].

Rate Limit Exceeded

• Once the request limit is reached, the servers will return an HTTP/429 ("API rate limit reached") response [2].
• The 429 Too Many Requests status code indicates that an application has exceeded Feedly's API rate limits [3].

Best Practices

1. Monitor the rate limit headers in API responses to track usage [3].
2. Implement appropriate retry mechanisms when handling 429 errors [3].
3. Keep the platform healthy by minimizing traffic and load when possible [5].
4. An acceptable rate would be:
   • 3 unread count requests per user per hour
   • 60 streams requests per user per hour
   • 20 search requests per user per hour [5]

Additional Information

• If an application needs more than the suggested rates, developers should contact Feedly to review the use case [5].
• Feedly may change these policies as deemed necessary, and continued use of Feedly Cloud constitutes acceptance of those changes [5].

By understanding and adhering to these rate limits, developers can ensure their applications integrate smoothly with the Feedly API while maintaining a healthy platform for all users.

Latest API Version

Based on the search results provided, here are the key points regarding the most recent version of the Feedly API:

Current API Version

The most recent version of the Feedly API appears to be v3. This can be seen in the API endpoint URL:

https://api.feedly.com/v3/search

Key Points

• The Feedly API is a REST API that uses HTTPS and is accessed from the api.feedly.com domain [1].

• It follows RESTful conventions and uses JSON for request and response bodies [1].

• To use the API, you need to generate an API Access Token from your Feedly account [1].

• The API documentation is available at developers.feedly.com [2][4].

• There have been recent updates to the API, including new features like deduplication of articles in the Streams API [2].

Best Practices

• Use HTTPS for all API interactions to ensure security [1].

• Follow the JSON conventions specified in the documentation, such as using camelCase for property names [1].

• Be aware of the request limits and status codes when using the API [4].

• Keep up to date with the changelog for new features and improvements [2].

In summary, while there isn't an explicit mention of a new major version release, the current version of the Feedly API is v3, and it continues to receive updates and improvements. Developers should refer to the official documentation at developers.feedly.com for the most up-to-date information on using the API.

How to get a Feedly developer account and API Keys?

To get a developer account for Feedly to create an API integration, here are the key steps:

1. Sign up for a Feedly Enterprise plan

• A Feedly Enterprise or Threat Intelligence Advanced plan is required to access the API.

2. Access the API Self Service Page

• Navigate to https://feedly.com/i/team/api to access the Self Service page.
• You will need admin rights on the account to generate API tokens.

3. Generate an API Access Token

• On the Self Service page, click "New API Token" to generate a token.
• Make sure to copy and save the token, as it will only be shown once.

4. Use the Access Token

• Use the generated token in the Authorization header of your API requests:

Authorization: Bearer YourAccessToken

Key Points to Consider

• Self-service API tokens are only available to Enterprise clients.
• There is a limit of 100,000 API requests per month included with the plan.
• For consumer applications, you may need to request special permission from Feedly.
• For business applications integrating Feedly for customers, each customer needs a Feedly Pro or Teams license.

Best Practices

• Securely store your API token and don't share it publicly.
• Review the Feedly API documentation for details on available endpoints and request formats.
• Be aware of rate limits and implement proper error handling in your integration.

If you need additional assistance or have specific requirements, you may need to contact Feedly support at [email protected].

What can you do with the Feedly API?

Here's a list of data models you can interact with using the Feedly API, along with what is possible for each:

Entries/Articles

• Retrieve articles from feeds, boards, or search results [1][2]
• Get article metadata including title, content, source information [2]
• Access cybersecurity metadata like CVEs, CVSS scores, exploit information [2]
• Retrieve AI-enriched data like topic classification, entity extraction, estimated CVSS scores [2]
• Save/bookmark articles to boards [2]
• Annotate articles with notes and highlights [1]

Feeds

• Get feed metadata and contents [2]
• Access feed stream IDs [2]
• Retrieve latest articles from a feed [2]
• Filter feed contents (e.g. important articles only) [2]

Boards

• Create and manage boards [2]
• Add articles to boards [1][2]
• Retrieve board contents [2]

Search

• Perform searches across feeds and content [1]
• Use AI models for advanced threat intelligence searches [3]

Entities

• Access entity data like CVEs, products, companies extracted by AI [2]
• Use entity autocomplete [1]

AI Models

• Leverage AI models for topic classification, entity extraction, CVSS scoring [2]
• Use AI for threat intelligence queries [3]

Trends

• Retrieve trend analysis data [1]

Authentication

• Generate and use API access tokens [1][2]

Miscellaneous

• Access user profile data [2]
• Retrieve continuation tokens for pagination [1]
• Get updated timestamps [1]

The API allows comprehensive access to Feedly's features, enabling integration with other systems for threat intelligence, research workflows, and more [2][3]. Data can be exported in formats like STIX for use in other platforms [3].