🔵Top Frames

Get a list of frame urls that are used by highly ranked profiles.

Discover high quality Frames (casts with frames) based on the ranking of profiles that have casted or engaged with the Frame (cast). The ranking of a Frame depends on a weighted linear combination of the scores of all the profiles that have interacted with the frame (cast) and the parameters of this API are used to control the weights and combination.

Developers can choose their own preferred strategies to rank frames. For simplicity, we have provided a reasonable default parameter setting.

This is a GET request to https://graph.cast.k3l.io/frames/global/rankings with a few optional parameters which are described further below.

/frames/global/rankings

Get Top Frames

get

Get a list of frame urls that are used by highly ranked profiles. This API takes four optional parameters - agg, weights, details, k and limit. Parameter agg is used to define the aggregation function and can take any of the following values - rms, sumsquare, sum.

Parameter weights is used to define the weights to be assigned to like, cast and recast actions by profiles.

Parameter details is used to specify whether the original cast list should be returned for each frame in the ranking.

(Note: cast hashes and warpcast urls are returned in chronological order ie., oldest first) (NOTE: details=True will result in a few extra hundred milliseconds in response times).

(NOTE: the API returns upto a max of 100 cast hashes and 100 warpcast urls when details=True).

Parameter offset is used to specify how many results to skip and can be useful for paginating through results.

Parameter limit is used to specify the number of results to return.

By default, agg=rms, weights=L1C10R5, details=False, offset=0 and limit=100 i.e., returns top 100 frame urls.

Query parameters

aggany ofOptionalDefault: sumsquare

string · enumOptionalPossible values:

or

nullOptional

weightsany ofOptionalDefault: L1C10R5

stringOptional

or

nullOptional

detailsany ofOptionalDefault: false

booleanOptional

or

nullOptional

offsetany ofOptionalDefault: 0

integerOptional

or

nullOptional

limitany ofOptionalDefault: 100

integer · max: 1000Optional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /frames/global/rankings HTTP/1.1
Host: graph.cast.k3l.io
Accept: */*

No content