Lens Content APIs
APIs for Content Recommendations
Posts by profiles are scored (value between 0 and 1), classified (recommendable, maybe recommendable, not recommendable) and ranked every hour. The posts can then be retrieved by clients through any of the following 4 APIs.
As an example, the /feed endpoint returns a JSON array of posts using the Popular algorithm as a default algorithm. To choose a different algorithm, specify the algorithm as a path parameter.
Let's walk through all the Global and Personalized content feed recommendation APIs next.
Global Feed
As for generalized (non-personalized) feed of posts according to each algorithm, we now have the following pre-computed algorithms. These algorithms are:
/feed/recentto choose the Recent algorithm./feed/popularto explicitly choose the Popular algorithm./feed/recommendedto choose the Recommended algorithm./feed/crowdsourcedto choose the Crowdsourced algorithm.
In addition to the algorithm path parameter, the endpoint also takes an optional limit query parameter. All the algorithms return a max of 100 posts. To get a smaller set of posts, specify the limit parameter. Example: /feed/recent?limit=10
Personalized Feed
Personalized content feed algorithms are meant to generate lists of posts that are most relevant to each user. These algorithms crawl a user's social graph and activity when recommending posts. There's a time decay element in this as well.
These algorithm deployed is:
/feed/personal/{profile}/followingwhich uses the Following strategy
In addition to the algorithm path parameter, the endpoint also takes an optional limit query parameter. All the algorithms return a max of 100 posts. To get a smaller set of posts, specify the limit parameter. Example: /feed/personal/karma3labs.lens/following?limit=10
API Documentation
Returns a list of posts based on a strategy that is personalized for the given profile.
The Lens profile handle (with or without the .lens extension) or hex Id.
The strategy name to use such as 'following'.
Number of entries to return. Defaults to 100.
Return results starting from this offset position. Defaults to start at 0, the first result.
The language of the posts to be retrieved.
Limite to top N ranked profiles. Defaults to 10000.
GET /feed/personal/{profile}/{strategy} HTTP/1.1
Host: lens-api.k3l.io
Accept: */*
[
{
"postId": "0x05-0x1e5a-DA-76b7ad36",
"handle": "stani.lens",
"mirrorsCount": 0,
"commentsCount": 10,
"collectsCount": 0,
"upvotesCount": 57,
"v": 0.8563457328149917,
"createdAt": "2023-06-13T17:38:04.000Z",
"contentUri": "ar://-aYLr71AMyMnjtvjq0daDWDg3SrDytTWPMd4GMw8W98"
}
]Returns a list of posts based on a strategy that is not personalized.
The strategy name to use such as 'recent', 'popular', 'recommended', or 'crowdsourced'.
Number of entries to return. Defaults to 100.
Return results starting from this offset position. Defaults to start at 0, the first result.
The language of the posts to be retrieved.
Limite to top N ranked profiles. Defaults to 10000.
GET /feed/{strategy} HTTP/1.1
Host: lens-api.k3l.io
Accept: */*
[
{
"postId": "0x05-0x1e5a-DA-76b7ad36",
"handle": "stani.lens",
"mirrorsCount": 0,
"commentsCount": 10,
"collectsCount": 0,
"upvotesCount": 57,
"v": 0.8563457328149917,
"createdAt": "2023-06-13T17:38:04.000Z",
"contentUri": "ar://-aYLr71AMyMnjtvjq0daDWDg3SrDytTWPMd4GMw8W98"
}
]You can try out this API at this OpenAPI interface — https://openapi.lens.k3l.io
Last updated