Skip to main content

Get related rising topics

GET 
/topics/:id/related/rising

Get the rising topics related to the specified topic. They are sorted by descending progression.

Only posts about the specified topic are used to calculate the volume of related topics. This ranking shows the progression of the related topics in the context of the specified topic.

For example, if the specified topic is "Bitcoin" and there are posts mentioning both "Bitcoin" and "Ethereum", the rising topics will show "Ethereum" as a related topic. Only posts about "Bitcoin" are used to calculate the volume of "Ethereum" in this context. Posts that only mention "Ethereum" are not used to calculate the volume of "Ethereum" in this context.

Note : Only topics with enough data in both current and previous time periods are taken into account. That's because topics with low volume can have a high progression rate, but it's not significant.

Cost: 1 credit per call.

Request​

Path Parameters

    id int32required

    Possible values: >= 1 and <= 2147483647

    The topic's id.

Query Parameters

    limit int32

    Possible values: >= 1 and <= 100

    Default value: 10

    The number of items to return in the ranking.

    startDate date-time

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|\+00:00)$

    The start date, used to filter results. It must respect RFC3339 format, UTC date-time without timezone. Examples : "1977-04-22T07:00:00.000Z", "1977-04-22T07:00:00.000+00:00".

    Note : the start date is inclusive, meaning that the results will include the start date.

    Limitations:

    • Default: the API returns the results for the last hour by default.
    • Maximum: the API can go back in time up to 15 days. If an older date is provided, the API will limit its results to 15 days.
    Example: 1977-04-22T06:00:00.000Z
    endDate date-time

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|\+00:00)$

    The end date, used to filter results. It must respect RFC3339 format, UTC date-time without timezone. Examples : "1977-04-22T07:00:00.000Z", "1977-04-22T07:00:00.000+00:00".

    Note : the end date is exclusive, meaning that the results will not include the end date.

    Limitations:

    • The endDate must be greater than the startDate, otherwise the API returns an error.
    Example: 1977-04-22T07:00:00.000Z
    sourceType string

    Possible values: [news, social]

    The source type, used to filter the results.

    domainName hostname

    Possible values: Value must match regular expression ^[a-z][0-9a-z.-]{1,100}\.[a-z]{2,4}$

    The domain name, used to filter the results.

    Example: example.com
    language languageModel

    Possible values: [aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    The ISO 639-1 language tag, used to filter the results.

    Example: fr

Header Parameters

    X-Exorde-Api-Version stringrequired

    Possible values: [v1]

    The API version.

Responses​

OK

Schema
    risingTopics objectrequired

    The progression of topics volume compared to the previous period.

    topics object[]required

    Possible values: <= 100

    Topics volume progression, sorted by descending progression.

  • Array [
    • id int32

    Possible values: >= 1 and <= 2147483647

    The topic ID.

    name stringrequired

    The topic name.

    count int32required

    The number of occurrences of this topic.

    progression floatrequired

    The progression of topics volume compared to the previous period. It's a percentage value.

  • ]
    • postsCount int32required

    The number of posts found for the query.

    startDate date-timerequired

    The lower bound date of data used to count the topics. It respect RFC3339 format, UTC date-time without timezone.

    endDate date-timerequired

    The upper bound date of data used to count the topics. It respect RFC3339 format, UTC date-time without timezone.

    status objectrequired
    cost int32required

    Number of credits that were consumed for this request.

    apiDeprecationNotice object

    Deprecation notice of the API.

    message stringrequired

    A message that tells when the API version will be shut down.

    shutdownDate date-timerequired

    The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Loading...
Last updated on