Get the sentiment
GEThttps://api.exorde.io/sentiment
Returns the computed sentiment.
Cost: 1 credit per call.
Request
Query Parameters
- 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.
- The
endDate
must be greater than thestartDate
, otherwise the API returns an error.
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:
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:
Possible values: >= 1
and <= 2147483647
The category's id, used to filter the results.
It should not be used with topicId
, if the category in the request does not match the topics's category, there will be no result.
Possible values: >= 1
and <= 2147483647
The topic's id, used to filter the results.
It should not be used with categoryId
, if the category in the request does not match the topics's category, there will be no result.
Possible values: [news
, social
]
The source type, used to filter the results.
Possible values: Value must match regular expression ^[a-z][0-9a-z.-]{0,100}\.[a-z]{2,4}$
The domain name, used to filter the results.
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.
Possible values: >= 1
, <= 5
A list of keywords used to filter the posts. Depends on keywords condition (or/and) to filter the posts.
This parameter is case-insensitive.
Possible values: [and
, or
]
Default value: and
The condition to return the posts that match one or all of the keywords passed in input.
Header Parameters
Possible values: [v1
]
The API version.
Responses
- 200
- 400
- 401
- 403
- 429
- 500
- 503
OK
- application/json
- Schema
- Example (from schema)
Schema
sentiment objectrequired
status objectrequired
{
"sentiment": {
"percentagePositivePosts": 0,
"percentageNegativePosts": 0,
"percentageNeutralPosts": 0,
"sentiment": 0,
"postsCount": 0,
"startDate": "1977-04-22T07:00:00.000Z",
"endDate": "1977-04-22T07:00:00.000Z"
},
"status": {
"cost": 0,
"apiDeprecationNotice": {
"message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
"shutdownDate": "2022-02-02T00:00:00.000Z"
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
status objectrequired
{
"error": {
"message": "An error occurred.",
"code": 0,
"userId": "123e4567-e89b-12d3-a456-426655440000",
"requestId": "123e4567-e89b-12d3-a456-426655440000"
},
"status": {
"cost": 0,
"apiDeprecationNotice": {
"message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
"shutdownDate": "2022-02-02T00:00:00.000Z"
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
status objectrequired
{
"error": {
"message": "An error occurred.",
"code": 0,
"userId": "123e4567-e89b-12d3-a456-426655440000",
"requestId": "123e4567-e89b-12d3-a456-426655440000"
},
"status": {
"cost": 0,
"apiDeprecationNotice": {
"message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
"shutdownDate": "2022-02-02T00:00:00.000Z"
}
}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
status objectrequired
{
"error": {
"message": "An error occurred.",
"code": 0,
"userId": "123e4567-e89b-12d3-a456-426655440000",
"requestId": "123e4567-e89b-12d3-a456-426655440000"
},
"status": {
"cost": 0,
"apiDeprecationNotice": {
"message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
"shutdownDate": "2022-02-02T00:00:00.000Z"
}
}
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
status objectrequired
{
"error": {
"message": "An error occurred.",
"code": 0,
"userId": "123e4567-e89b-12d3-a456-426655440000",
"requestId": "123e4567-e89b-12d3-a456-426655440000"
},
"status": {
"cost": 0,
"apiDeprecationNotice": {
"message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
"shutdownDate": "2022-02-02T00:00:00.000Z"
}
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
The id of the request.
{
"requestId": "123e4567-e89b-12d3-a456-426655440000"
}
Service Unavailable
Authorization: http
name: apiKeytype: httpscheme: bearerdescription: ### Acquiring an API key All HTTP requests made against the Exorde API must be validated with an API key. If you don't have an API key yet, create one from the [developers portal](https://developers.exorde.io). ### Using Your API key The Exorde API uses a bearer token authentication mechanism. The API key acts as a token and must be provided in the `Authorization` header of your request. For example : ```bash curl \ --url https://api.exorde.io/posts \ --header "X-Exorde-Api-Version: v1" \ --header "Accept: application/json" \ --header "Authorization: Bearer <api-key>" ```
- curl
- python
- nodejs
- CURL
curl -L -X GET 'https://api.exorde.io/sentiment' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'