Here you can find all available requests to our API.
These parameters are always necessary, not only when signing in.
If you have any questions or comments, please contact our service desk at
{{variables}} are just there to pinpoint that you have to use your own values or values that we agreed upon such as {{API-url}} and {{VERSION}}.
{{API-url} - https://app.cikisi.com/api
{{version}} - v2
In the response headers(if authentication was successful) these five parameters can be found:
These five parameters are REQUIRED to make further requests to our API. These should be sent in the request headers.
These parameters should be included(in the headers) in every request made to our API.
These parameters are always necessary, not only when signing in.
Please check the image below.
The per_page parameter allows you to configure the maximum amount of hits to be returned
The page parameter defines the Items that are published after that date.
Date from defines Items that are published after that date.
(When publication date is not available in the orignal page, or not well identified by Cikisi, then the publication date is linked to the creation date)
Date to defines Items that are published until that date.
(When publication date is not available in the orignal page, or not well identified by Cikisi, then the publication date is linked to the creation date)
Sort by defines in which way you want to sort fetched Items: [publication_date, created_at, relevance, engagements, views]
Sort direction defines in what order to view the items: [ASC, DESC]
The value by default (metadata=0) allows you to receive the items with their basic metadata: [ id, title, description, content, publication_date, created_at, source information]
Metadata=1 allows you to receive the items with all the metadata including [Name Entities and keywords, collections, tags, geolocations]
Auth
User Authorization
curl --location --request POST '{{CIKISI_URL}}/api/auth/sign_in' \
--form 'email={{Email}}' \
--form 'password={{Password}}'
Collection Items
curl --location --request GET '{{CIKISI_URL}}/api/v2/collections/{{collection_id}}/items?per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'
Theme Items
Topic Items
curl --location --request GET '{{CIKISI_URL}}/api/v2/topics//items?per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'
curl --location --request GET '{{CIKISI_URL}}/api/v2/themes/{{theme_id}}/items?per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'
Source Items
curl --location --request GET '{{CIKISI_URL}}/api/v2/sources/{{source_id}}/items?per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'
Item Tags Items
curl --location --request GET '{{CIKISI_URL}}/api/v2/item_tags/items?name[]={{Tag%20Names}}&per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'
Source Categories Items
curl --location --request GET 'https://www.wmt.cikisi.com/api/v2/source_categories/items?name[]={{Categories%20Names}}&per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'
Geolocated Items
ex. "10km"
ex. 123.123
ex. -123.123
curl --location --request GET '{{CIKISI_URL}}api/v2/geolocated/items?radius={{Radius}}&lat={{Latitude}}&lon={{Longitude}}&per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'
(Cikisi Saved) Searches Items
curl --location --request GET '{{CIKISI_URL}}/api/v2/searches//items?per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'
Similar Items
Check for similar items based on title of Item
Check for similar items based on content of Item
curl --location --request GET '{{CIKISI_URL}}/api/v2/similar/items?title={{title}}&content={{content}}&per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'
Search Items
curl --location --request GET '{{CIKISI_URL}}/api/v2/search?keywords={{keywords}}&per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'