Lens Profile APIs
APIs for Profile Scores and Ranking
Last updated
APIs for Profile Scores and Ranking
Last updated
All profiles in the Lens ecosystem are scored and ranked every hour. The scores and rankings are then made available through 5 different APIs that clients can call depending on their use case.
Purpose: Retrieve a single profile score on the Lens ecosystem
The /profile/score
endpoint retrieves a single profile score. Each profile score
ranges between 0
and 1
, with 0
being the lowest score and 1
being the highest score.
This endpoint requires a strategy
parameter as described in the section. This strategy simplifies the developer experience abstracting away the EigenTrust Local-Trust and Pre-Trust strategies. Each strategy is pre-computed on a daily basis and applied to each Lens profile.
By using the date
parameter, you can choose a particular day when the strategies were generated. This is helpful to get a snapshot in time of where each profile scores and ranks are, to help develop time series metrics dashboards for each profile to see how their scores trend over time.
You can try out this API at this OpenAPI interface —
Purpose: Retrieve a list of global profile scores on the Lens ecosystem
The /profile/scores
endpoint retrieves a list of numeric profile scores and ranks in relations with all other profiles, ordered by the highest score. Each profile score
ranges between 0
and 1
, with 0
being the lowest score and 1
being the highest score.
This endpoint also returns a rank
position, starting with 1
as the top-ranked profile calculated for the day, and n
being the lowest ranked, with n
being the number of profiles included in the converged scoring calculations for the day.
This endpoint requires a strategy
parameter as described in the section. This strategy simplifies the developer experience abstracting away the EigenTrust Local-Trust and Pre-Trust strategies. Each strategy is pre-computed on a daily basis and applied to each Lens profile.
The results returned are paginated to 50 profiles per response by default. This can be managed with a limit
parameter with pagination alongside an offset
parameter (first record at offset
position 0
). To help with pagination, you can use the Profile Count endpoint to retrieve the total number of profiles available.
By using the date
parameter, you can choose a particular day when the strategies were generated. This is helpful to get a snapshot in time of where each profile scores and ranks are, to help develop time series metrics dashboards for each profile to see how their scores trend over time.
Purpose: Retrieve a list of global profile scores of a subset of users in the Lens ecosystem.
The /profile/scores_by_users
endpoint retrieves a list of profile scores of a subset of users requested, and it will return with profile scores ranked in relations with all other profiles, ordered by the highest score. Each profile score
ranges between 0
and 1
, with 0
being the lowest score and 1
being the highest score.
This endpoint also returns a rank
position, starting with 1
as the top-ranked profile calculated for the day, and n
being the lowest ranked, with n
being the number of profiles included in the converged scoring calculations for the day.
The results returned are paginated to 50 profiles per response by default. This can be managed with a limit
parameter with pagination alongside an offset
parameter (first record at offset
position 0
). To help with pagination, you can use the Profile Count endpoint to retrieve the total number of profiles available.
By using the date
parameter, you can choose a particular day when the strategies were generated. This is helpful to get a snapshot in time of where each profile scores and ranks are, to help develop time series metrics dashboards for each profile to see how their scores trend over time.
Purpose: Retrieve the total number of profiles found on the Lens ecosystem
This /profile/count
endpoint retrieves the total number of profiles scored for a particular strategy. The returned value is an unsigned integer.
There's a option to choose a particular day of how many profiles are available when the strategies were generated using the date
parameter.
Purpose: Retrieve a profile's score position, in relations to all other profiles, on the Lens ecosystem
This /profile/rank
endpoint retrieves a particular profile's score position (ranked) for a particular strategy, in relations to all the other profiles in the Lens ecosystem. The returned value is an unsigned integer starting with 1
.
There's a option to choose a particular day of how many profiles are available when the strategies were generated using the date
parameter.
This endpoint requires a strategy
parameter as described in the section. This strategy simplifies the developer experience abstracting away the EigenTrust Local-Trust and Pre-Trust strategies. Each strategy is pre-computed on a daily basis and applied to each Lens profile.
This endpoint requires a strategy
parameter as described in the section. This strategy simplifies the developer experience abstracting away the EigenTrust Local-Trust and Pre-Trust strategies. Each strategy is pre-computed on a daily basis and applied to each Lens profile.
This endpoint requires a strategy
parameter as described in the section. This strategy simplifies the developer experience abstracting away the EigenTrust Local-Trust and Pre-Trust strategies. Each strategy is pre-computed on a daily basis and applied to each Lens profile.
Tryout the APIs here! —
Returns the global profile scores, ordered by the highest scoring profiles, according to a given strategy.
The strategy name to use such as 'followship', 'engagement', 'influencer', or 'creator'.
Return results starting from this offset position. Defaults to start at 0
, the first result.
Number of entries to return. Defaults to 50
.
A date, in YYYY-MM-DD
format, for which to return the historic result. Defaults to the most recent date.
The requested profiles, whose scores are
within the [limit, limit+offset)
range.
Returns the global profile score of a user based on a strategy.
The strategy name to use such as 'followship', 'engagement', 'influencer', or 'creator'.
The Lens profile handle (with or without the .lens
extension).
A date, in YYYY-MM-DD
format, for which to return the historic result. Defaults to the most recent date.
Returns the global profile scores of a list of users, ordered by the highest scoring profiles, according to a given strategy.
The strategy name to use such as 'followship', 'engagement', 'influencer', or 'creator'.
A list of comma separated profile handles (with or without the .lens
extension).
A date, in YYYY-MM-DD
format, for which to return the historic result. Defaults to the most recent date.
The requested profiles along with their scores and ranks.
Returns the number of profiles available for a given strategy.
As an example, this can be used to display the number of pages on a paginated dashboard.
The strategy name to use such as 'followship', 'engagement', 'influencer', or 'creator'.
A date, in YYYY-MM-DD
format, for which to return the historic result. Defaults to the most recent date.
Retrieves a particular profile's position ranked in relations to the result set of a strategy.
The strategy name to use such as 'followship', 'engagement', 'influencer', or 'creator'.
The Lens profile handle (with or without the .lens
extension).
A date, in YYYY-MM-DD
format, for which to return the historic result. Defaults to the most recent date.