CINXE.COM
<!doctype html> <html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-apiReference docs-doc-id-api-index"> <head> <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.2.0"> <title data-rh="true">Talkwalker API Reference | Talkwalker Developer Portal</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://developer.talkwalker.com/api/"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-apiReference-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-apiReference-current"><meta data-rh="true" property="og:title" content="Talkwalker API Reference | Talkwalker Developer Portal"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://developer.talkwalker.com/api/"><link data-rh="true" rel="alternate" href="https://developer.talkwalker.com/api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://developer.talkwalker.com/api/" hreflang="x-default"><link rel="preconnect" href="https://www.google-analytics.com"> <link rel="preconnect" href="https://www.googletagmanager.com"> <script async src="https://www.googletagmanager.com/gtag/js?id=G-B4C5MQHQZ7"></script> <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-B4C5MQHQZ7",{anonymize_ip:!0})</script> <link rel="search" type="application/opensearchdescription+xml" title="Talkwalker Developer Portal" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.0022d80e.css"> <link rel="preload" href="/assets/js/runtime~main.d41a1cce.js" as="script"> <link rel="preload" href="/assets/js/main.6820cca8.js" as="script"> </head> <body class="navigation-with-keyboard"> <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/tw-white-logo.png" alt="Talkwalker logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/tw-white-logo.png" alt="Talkwalker logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Dev Portal</b></a><a class="navbar__item navbar__link" href="/docs">Getting started</a><a class="navbar__item navbar__link" href="/guides">Guides</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/api">API reference</a></div><div class="navbar__items navbar__items--right"><div class="searchBox_ZlJk"><style data-emotion="css gw6uol">.css-gw6uol{box-sizing:border-box;margin:0;min-width:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;position:relative;cursor:pointer;}</style><div class="css-gw6uol"><style data-emotion="css 1a9o7yh">.css-1a9o7yh{box-sizing:border-box;margin:0;min-width:0;position:absolute;left:8px;top:1px;-webkit-transform:scale(0.66666);-moz-transform:scale(0.66666);-ms-transform:scale(0.66666);transform:scale(0.66666);}</style><div class="css-1a9o7yh"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg></div><style data-emotion="css 1oo907j">.css-1oo907j{box-sizing:border-box;margin:0;min-width:0;display:block;width:100%;padding:8px;-webkit-appearance:none;-moz-appearance:none;-ms-appearance:none;appearance:none;font-size:inherit;line-height:inherit;border:1px solid;border-radius:4px;color:inherit;background-color:transparent;height:26px;border-radius:12px;background-color:white;width:100px;cursor:pointer;}.css-1oo907j:autofill,.css-1oo907j:autofill:hover,.css-1oo907j:autofill:focus{box-shadow:inset 0 0 0 1000px var(--theme-ui-input-autofill-bg);font-size:inherit;}.css-1oo907j:autofill:first-line,.css-1oo907j:autofill:hover:first-line,.css-1oo907j:autofill:focus:first-line{font-size:1rem;}.css-1oo907j:-webkit-autofill,.css-1oo907j:-webkit-autofill:hover,.css-1oo907j:-webkit-autofill:focus{box-shadow:inset 0 0 0 1000px var(--theme-ui-input-autofill-bg);font-size:inherit;}.css-1oo907j:-webkit-autofill:first-line,.css-1oo907j:-webkit-autofill:hover:first-line,.css-1oo907j:-webkit-autofill:focus:first-line{font-size:1rem;}.css-1oo907j::-webkit-input-placeholder{position:relative;color:#9eb5d9;font:13px Roboto;padding-left:24px;top:0px;}.css-1oo907j::-moz-placeholder{position:relative;color:#9eb5d9;font:13px Roboto;padding-left:24px;top:0px;}.css-1oo907j:-ms-input-placeholder{position:relative;color:#9eb5d9;font:13px Roboto;padding-left:24px;top:0px;}.css-1oo907j::placeholder{position:relative;color:#9eb5d9;font:13px Roboto;padding-left:24px;top:0px;}</style><input translations="[object Object]" placeholder="Search" class="css-1oo907j"></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current="page" aria-expanded="true" href="/api/">API Reference</a><button aria-label="Toggle the collapsible sidebar category 'API Reference'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api/endpoints">Endpoints</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api/talkwalker-ap-is">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/status-api">Status API</a><button aria-label="Toggle the collapsible sidebar category 'Status API'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/search-api">Search API</a><button aria-label="Toggle the collapsible sidebar category 'Search API'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/search-api-histogram-api">Search API > Histogram API</a><button aria-label="Toggle the collapsible sidebar category 'Search API > Histogram API'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/streaming-api">Streaming API</a><button aria-label="Toggle the collapsible sidebar category 'Streaming API'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/streaming-api-collector-api">Streaming API > Collector API</a><button aria-label="Toggle the collapsible sidebar category 'Streaming API > Collector API'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/streaming-api-task-api">Streaming API > Task API</a><button aria-label="Toggle the collapsible sidebar category 'Streaming API > Task API'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/modify-documents-api">Modify documents API</a><button aria-label="Toggle the collapsible sidebar category 'Modify documents API'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/resources-api">Resources API</a><button aria-label="Toggle the collapsible sidebar category 'Resources API'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/topic-api">Topic API</a><button aria-label="Toggle the collapsible sidebar category 'Topic API'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/source-panels-api">Source panels API</a><button aria-label="Toggle the collapsible sidebar category 'Source panels API'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/api/image-api">Image API</a><button aria-label="Toggle the collapsible sidebar category 'Image API'" type="button" class="clean-btn menu__caret"></button></div></li></ul></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_Zlfk"><div class="docItemContainer_lYsu"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">API Reference</span><meta itemprop="position" content="1"></li></ul></nav><div class="theme-doc-markdown markdown"><header><h1>Talkwalker API Reference</h1></header><div class="row"><div class="col col--12"><br><section class="row"><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/endpoints"><h2 class="text--truncate cardTitle_HoSo" title="Endpoints"> <!-- -->Endpoints</h2><p class="text--truncate cardDescription_c27F" title="Reference documentation for endpoints provided by the API.">Reference documentation for endpoints provided by the API.</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/talkwalker-ap-is"><h2 class="text--truncate cardTitle_HoSo" title="Introduction"> <!-- -->Introduction</h2><p class="text--truncate cardDescription_c27F" title="Talkwalker Advanced API">Talkwalker Advanced API</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/status-api"><h2 class="text--truncate cardTitle_HoSo" title="Status API"> <!-- -->Status API</h2><p class="text--truncate cardDescription_c27F" title="1 items">1 items</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/search-api"><h2 class="text--truncate cardTitle_HoSo" title="Search API"> <!-- -->Search API</h2><p class="text--truncate cardDescription_c27F" title="3 items">3 items</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/search-api-histogram-api"><h2 class="text--truncate cardTitle_HoSo" title="Search API > Histogram API"> <!-- -->Search API > Histogram API</h2><p class="text--truncate cardDescription_c27F" title="3 items">3 items</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/streaming-api"><h2 class="text--truncate cardTitle_HoSo" title="Streaming API"> <!-- -->Streaming API</h2><p class="text--truncate cardDescription_c27F" title="8 items">8 items</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/streaming-api-collector-api"><h2 class="text--truncate cardTitle_HoSo" title="Streaming API > Collector API"> <!-- -->Streaming API > Collector API</h2><p class="text--truncate cardDescription_c27F" title="6 items">6 items</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/streaming-api-task-api"><h2 class="text--truncate cardTitle_HoSo" title="Streaming API > Task API"> <!-- -->Streaming API > Task API</h2><p class="text--truncate cardDescription_c27F" title="6 items">6 items</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/modify-documents-api"><h2 class="text--truncate cardTitle_HoSo" title="Modify documents API"> <!-- -->Modify documents API</h2><p class="text--truncate cardDescription_c27F" title="4 items">4 items</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/resources-api"><h2 class="text--truncate cardTitle_HoSo" title="Resources API"> <!-- -->Resources API</h2><p class="text--truncate cardDescription_c27F" title="8 items">8 items</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/topic-api"><h2 class="text--truncate cardTitle_HoSo" title="Topic API"> <!-- -->Topic API</h2><p class="text--truncate cardDescription_c27F" title="4 items">4 items</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/source-panels-api"><h2 class="text--truncate cardTitle_HoSo" title="Source panels API"> <!-- -->Source panels API</h2><p class="text--truncate cardDescription_c27F" title="3 items">3 items</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href="/api/image-api"><h2 class="text--truncate cardTitle_HoSo" title="Image API"> <!-- -->Image API</h2><p class="text--truncate cardDescription_c27F" title="2 items">2 items</p></a></article></section></div></div></div><div class="col col--12"></div></article><div class="col col--12"><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--next" href="/api/endpoints"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Talkwalker APIs</div></a></nav></div></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__links text--center"><div class="footer__links"><span class="footer__link-item"> <div class="footer-contact-us"> <a href="mailto:support@talkwalker.com?Subject=Question%20regarding%20API%20documentation" class="footer-contact-us-text" target="__blank"> Contact us </a> </div> </span></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright 漏 2025 Talkwalker Inc. All Rights Reserved</div></div></div></footer></div> <script src="/assets/js/runtime~main.d41a1cce.js"></script> <script src="/assets/js/main.6820cca8.js"></script> </body> </html>