Wikidot API - Wikidot - Free and Pro Wiki Hosting

<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>Wikidot API - Wikidot - Free and Pro Wiki Hosting</title> <script type="text/javascript" src="http://d3g0gp89917ko0.cloudfront.net/v--4b961b7cc327/common--javascript/init.combined.js"></script> <script type="text/javascript"> var URL_HOST = 'www.wikidot.com'; var URL_DOMAIN = 'wikidot.com'; var USE_SSL = true ; var URL_STATIC = 'http://d3g0gp89917ko0.cloudfront.net/v--4b961b7cc327'; // global request information var WIKIREQUEST = {}; WIKIREQUEST.info = {}; WIKIREQUEST.info.domain = "www.wikidot.com"; WIKIREQUEST.info.siteId = 648902; WIKIREQUEST.info.siteUnixName = "www"; WIKIREQUEST.info.categoryId = 4388016; WIKIREQUEST.info.themeId = 192065; WIKIREQUEST.info.requestPageName = "doc:api"; OZONE.request.timestamp = 1732839037; OZONE.request.date = new Date(); WIKIREQUEST.info.lang = 'en'; WIKIREQUEST.info.pageUnixName = "doc:api"; WIKIREQUEST.info.pageId = 22129646; WIKIREQUEST.info.lang = "en"; OZONE.lang = "en"; var isUAMobile = !!/Android|webOS|iPhone|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent); </script> <script type="text/javascript"> require.config({ baseUrl: URL_STATIC + '/common--javascript', paths: { 'jquery.ui': 'jquery-ui.min', 'jquery.form': 'jquery.form' } }); </script> <meta http-equiv="content-type" content="text/html;charset=UTF-8"/> <meta http-equiv="content-language" content="en"/> <script type="text/javascript" src="http://d3g0gp89917ko0.cloudfront.net/v--4b961b7cc327/common--javascript/WIKIDOT.combined.js"></script> <script type="text/javascript" src="http://d3g0gp89917ko0.cloudfront.net/v--4b961b7cc327/common--bootstrap/3.0.0/bootstrap.min.js"></script>  <link href="http://d3g0gp89917ko0.cloudfront.net/v--4b961b7cc327/common--fonts/awesome/3.2.1/font-awesome.min.css" rel="stylesheet"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <style type="text/css" id="internal-style"> /* modules */ /* bootstrap */ @import url(http://d3g0gp89917ko0.cloudfront.net/v--4b961b7cc327/common--bootstrap/3.0.0/bootstrap.min.css); /* theme */ @import url(http://d3g0gp89917ko0.cloudfront.net/v--4b961b7cc327/common--theme/bootstrap-base/css/style.css); @import url(http://www.wdfiles.com/local--theme/wikidot-3-0-content/style.css); </style>   <script type="text/javascript" src="http://d3g0gp89917ko0.cloudfront.net/v--4b961b7cc327/common--javascript/skrollr.min.js"></script> <link rel="shortcut icon" href="/local--favicon/favicon.gif"/> <link rel="icon" type="image/gif" href="/local--favicon/favicon.gif"/> <link rel="apple-touch-icon" href="/common--images/apple-touch-icon-57x57.png" /> <link rel="apple-touch-icon" sizes="72x72" href="/common--images/apple-touch-icon-72x72.png" /> <link rel="apple-touch-icon" sizes="114x114" href="/common--images/apple-touch-icon-114x114.png" /> <link rel="alternate" type="application/wiki" title="Edit this page" href="javascript:WIKIDOT.page.listeners.editClick()"/> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-18234656-1']); _gaq.push(['_setDomainName', 'none']); _gaq.push(['_setAllowLinker', true]); _gaq.push(['_trackPageview']); _gaq.push(['old._setAccount', 'UA-68540-5']); _gaq.push(['old._setDomainName', 'none']); _gaq.push(['old._setAllowLinker', true]); _gaq.push(['old._trackPageview']); </script> <script type="text/javascript"> window.google_analytics_uacct = 'UA-18234656-1'; window.google_analytics_domain_name = 'none'; </script> <link rel="manifest" href="/onesignal/manifest.json" /> <script src="https://cdn.onesignal.com/sdks/OneSignalSDK.js" acync=""></script> <script> var OneSignal = window.OneSignal || []; OneSignal.push(function() { OneSignal.init({ appId: null, }); }); </script> </head> <body id="html-body"> <div id="skrollr-body"> <script type="text/javascript"> jQuery(document).ready(function() { if(!(/Android|iPhone|iPad|iPod|BlackBerry|Windows Phone/i).test(navigator.userAgent || navigator.vendor || window.opera)) { var s = skrollr.init(); } }); </script> <div class="topbar"> <nav class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="container"> <div class="navbar-header"> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".wikidot-menu-collapse"> Toggle navigation </button> <div class="site-name"> <a class="navbar-brand" href="/"></a> </div> <div class="site-subtitle"> your place on the web </div> <div class="loginStatus"> <a href="javascript:;" onclick="WIKIDOT.page.listeners.createAccount(event)" class="login-status-create-account btn">Create account</a> or <a href="javascript:;" onclick="WIKIDOT.page.listeners.loginClick(event)" class="login-status-sign-in btn btn-primary">Sign in</a> </div> </div> <div class="collapse navbar-collapse wikidot-menu-collapse"> <ul class="nav navbar-nav navbar-right"> <li class="dropdown"><a class="dropdown-toggle" href="" data-toggle="dropdown">Documentation   </a> <ul class="dropdown-menu"> <li><a href="/doc-wiki-syntax:start">Wiki syntax</a></li> <li><a href="/doc:quick-reference">Quick reference</a></li> <li><a href="/doc-modules:start">Modules</a></li> <li><a href="/doc-data-forms:start">Data forms</a></li> <li><a href="/doc:embedding">Embedding services</a></li> <li><a href="/doc:templates">Templates</a></li> <li><a href="/doc:searching">Searching</a></li> <li><a href="/doc:site-structure">Site structure</a></li> <li><a href="/doc:users">Managing users</a></li> <li><a href="/doc:layout-reference">Layout reference</a></li> <li><a href="/doc:video">Video tutorials</a></li> <li><a href="/doc:advertising">Advertising</a></li> <li><a href="/doc:api">Wikidot API</a></li> </ul> </li> <li class="dropdown"><a class="dropdown-toggle" href="" data-toggle="dropdown">Community sites  </a> <ul class="dropdown-menu"> <li><a href="http://community.wikidot.com">Wikidot Community</a></li> <li><a href="http://handbook.wikidot.com">Wikidot Handbook</a></li> <li><a href="http://snippets.wikidot.com">Code snippets</a></li> </ul> </li> <li class="dropdown"><a class="dropdown-toggle" href="" data-toggle="dropdown">FAQ  </a> <ul class="dropdown-menu"> <li><a href="/faq:user-accounts">User accounts</a></li> <li><a href="/faq:upgrades">Upgrades</a></li> <li><a href="/faq:site-features">Site features</a></li> <li><a href="/faq:private-sites">Private Sites</a></li> <li><a href="/faq:editing-pages">Editing Pages</a></li> <li><a href="/faq:technical">Technical</a></li> <li><a href="/faq:watching">Watching</a></li> </ul> </li> </ul> </div> </div> <div class="horizontal-scrollbar" data-start="width: 0%;" data-end="width: 100%"></div> </nav> </div> <div class="content-wrap"> <div class="container"> <div class="row"> <div class="col-md-3"> <div class="search-box"> <div id="search-top-box" class="form-search"> <form id="search-top-box-form" action="dummy" class="input-append"> <input id="search-top-box-input" class="text empty search-query" type="text" size="15" name="query" value="Search this site" onfocus="if(YAHOO.util.Dom.hasClass(this, 'empty')){YAHOO.util.Dom.removeClass(this,'empty'); this.value='';}"/><input class="button btn" type="submit" name="search" value="Search"/> </form> </div> </div> <nav role="navigation"> <div class="container"> <div class="navbar-header docs-navigation"> <a type="button" class="btn btn-default navbar-toggle docs-navigation-toggle" data-toggle="collapse" data-target=".doc-menu-collapse"> Table of Contents </a> </div> <div class="collapse navbar-collapse doc-menu-collapse doc-navigation-sidebar"> <h4 >Documentation pages</h4> <ul> <li><a href="/doc-wiki-syntax:start">Wiki syntax</a></li> <li><a href="/doc:quick-reference">Quick reference</a></li> <li><a href="/doc:modules">Modules</a></li> <li><a href="/doc:data-forms">Data forms</a></li> <li><a href="/doc:embedding">Embedding other services</a></li> <li><a href="/doc:templates">Templates</a></li> <li><a href="/doc:searching">Searching</a></li> <li><a href="/doc:site-structure">Site structure</a></li> <li><a href="/doc:users">Users</a></li> <li><a href="/doc:layout-reference">Layout reference</a></li> <li><a href="/doc:thumbnails">Thumbnails</a></li> <li><a href="/doc:video">Video Tutorials</a></li> <li><a href="/doc:advertising">Advertising</a></li> <li><a href="/doc:api">Wikidot API</a></li> <li><a href="/doc:expressions">Expressions</a></li> </ul> <h4 >FAQ (Frequently Asked Questions)</h4> <ul> <li><a href="/faq:upgrades">Upgrades and Plans</a></li> <li><a href="/faq:community-sites">Community Sites</a></li> <li><a href="/faq:user-accounts">User accounts</a></li> <li><a href="/faq:site-features">Site features</a></li> <li><a href="/faq:private-sites">Private sites</a></li> <li><a href="/faq:editing-pages">Editing pages</a></li> <li><a href="/faq:watching">Watching changes</a></li> <li><a href="/faq:technical">Technical</a></li> </ul> </div> </div> </nav> </div> <div class="col-md-9"> <div class="page-title"> Wikidot API </div> <div class="breadcrumb"> <a href="/doc:start">Documentation</a> » Wikidot API </div> <div id="page-content"> The main concept of naming is as follows: <ul> <li>namespace is type of object you work with</li> <li>select methods return array of names</li> <li>get methods return array of all data of matched objects</li> <li>get_one methods return array of all data of one matched object</li> </ul> The list will grow as the methods are added. The methods are discussed <a href="http://developer.wikidot.com/forum/t-257156">here</a>. XML-RPC api is limited to 240 req/min (per user). <h2 id="toc0">categories.select</h2> Select all categories from given site <ul> <li>argument keys: <ul> <li>site: site to get pages from, e.g. "my-site"</li> </ul> </li> <li>returns: list of category names</li> </ul> <div class="code"> <div class="hl-main"> <pre> >>> s.categories.select({"site": "my-site"}) ["_default", "admin", "forum", "system", "blog"] </pre></div> </div> <h2 id="toc1">files.select</h2> Get names of files attached to page <ul> <li>argument keys: <ul> <li>site: what site we ask about</li> <li>page: what page (full name) we ask about</li> </ul> </li> <li>returns: list of file names</li> </ul> <h2 id="toc2">files.get_meta</h2> Get meta data of given files <ul> <li>argument keys: <ul> <li>site: what site we ask about</li> <li>page: what page (full name) we ask about</li> <li>files: name of files to get meta data of — max 10 of them</li> </ul> </li> <li>returns: dictionary of files. File name is key of each item in it. The value is a dictionary of: <ul> <li>size — size in bytes</li> <li>comment</li> <li>mime_type</li> <li>mime_description</li> <li>uploaded_by</li> <li>uploaded_at</li> <li>download_url — URL to download the file from. For private sites, the URL contains authorization token <tt>?ukey=...</tt> valid for about 5 minutes.</li> </ul> </li> </ul> <h2 id="toc3">files.get_one</h2> <div class="wiki-note"> This method works for small files only (max 6MB). </div> Get file attached to page (alternatively you can use download_url from get_meta method above) <ul> <li>argument keys: <ul> <li>site: site to get page from</li> <li>page: page to get file from</li> <li>file: name of file to get</li> </ul> </li> <li>returns: dictionary with the same keys as files.get_meta and additionally: <ul> <li>content — base64-encoded file contents</li> </ul> </li> </ul> <h2 id="toc4">files.save_one</h2> <div class="wiki-note"> With this method you can attach files not bigger than 50MB. Other file size limits also apply: <ul> <li>site storage — can't upload file bigger than current unused file storage for site</li> <li>maximum file size depending on free/Pro Wikidot plan</li> </ul> </div> Attaches file to page <ul> <li>argument keys: <ul> <li>site: site of page to attach file to</li> <li>page: page to attach file to</li> <li>file: name of file to attach</li> <li>comment (optional): file description</li> <li>save_mode (optional): allowed mode of operation <ul> <li>create — only allow creating new objects (exception thrown if object with this name already exists)</li> <li>update — only allow updating objects (exception thrown if no object with this name exists)</li> <li>create_or_update (default) — allow both creating and updating object</li> </ul> </li> <li>content: base64-encoded file content</li> <li>notify_watchers (optional): <ul> <li>true: notify watchers about the edit (as if it was done with the web interface)</li> <li>false (default): don't notify watchers</li> </ul> </li> <li>revision_comment (optional): revision comment (displayed in history)</li> </ul> </li> <li>returns: the newly uploaded file information as dictionary the same to what files.get_meta return for each file</li> </ul> <h2 id="toc5">tags.select</h2> Select all tags from pages from given site or page or category <ul> <li>argument keys: <ul> <li>site: site to get pages to get tags from, e.g. "my-site"</li> <li>categories (optional): list of names of categories to get pages to get tags from</li> <li>pages (optional): list of full names of pages to get tags from — max 10 of them</li> </ul> </li> <li>returns: list of tags</li> </ul> <h2 id="toc6">pages.select</h2> Select pages that match given criteria <ul> <li>argument keys (if not stated otherwise, possible values documented in <a href="/doc:listpages-module">ListPages module</a>): <ul> <li>site: site to get pages from, e.g. "my-site"</li> <li>pagetype (optional): default "*"</li> <li>categories (optional): list of category names to pull pages from, default: all categories</li> <li>tags_any (optional): list of tags, page must have at least one of them</li> <li>tags_all (optional): list of tags, page must have all of them</li> <li>tags_none (optional): list of tags, page must have none of them</li> <li>parent (optional): single page name or "-" for pages with no parent</li> <li>created_by (optional): single user name</li> <li>rating (optional)</li> <li>order (optional)</li> </ul> </li> <li>returns: list of page full names</li> </ul> <div class="code"> <div class="hl-main"> <pre> >>> s.pages.select({"site": "my-site", "categories": ["blog", "news"], "tags_none": ["_draft"], "order": "created_at desc"}) ["blog:last-post", "blog:second-post", "blog:first-post", "blog:_template"] </pre></div> </div> <h2 id="toc7">pages.get_meta</h2> Get a bunch of pages and returns (some of) their meta data <ul> <li>argument keys: <ul> <li>site: site to list pages from, eg. "my-site"</li> <li>pages: list of page full names to list (maximum 10 pages)</li> </ul> </li> <li>returns dictionary of pages. For each page there will be item in the dictionary with page name as key and dictionary of the following page properties as value: <ul> <li>fullname</li> <li>created_at</li> <li>created_by</li> <li>updated_at</li> <li>updated_by</li> <li>title</li> <li>parent_fullname</li> <li>tags — list of all tags (including those starting with underscore)</li> <li>rating</li> <li>revisions</li> <li>[PLANNED] comments — number of comments</li> <li>[PLANNED] files — number of files attached to the page</li> <li>[PLANNED] children — number of children pages</li> </ul> </li> </ul> <div class="code"> <div class="hl-main"> <pre> >>> s.pages.meta({"site": "my-site", "pages": ["blog:last-post", "blog:second-post"]}) { "blog:last-post": {"fullname": "blog:last-post", "created_at": "2010-08-04T23:20:50Z", "created_by": "Gabrys", "updated_at": "2010-08-04T23:23:31Z", "updated_by": "Gabrys", "title": "Last Post", "parent_fullname": None, "tags": ["blog", "last"], "rating": 8, "revisions": 2}, "blog:second-post": {"fullname": "blog:second-post", "created_at": "2010-08-03T22:52:10Z", "created_by": "Gabrys", "updated_at": "2010-08-03T22:52:10Z", "updated_by": "Gabrys", "title": "Second Post", "parent_fullname": None, "tags": ["blog", "second"], "rating": 1, "revisions": 1} } </pre></div> </div> <h2 id="toc8">pages.get_one</h2> Gets one page and returns all its properties <ul> <li>argument keys: <ul> <li>site: site to get a page from, e.g. "my-site"</li> <li>page: page full name to get, e.g. "start" or "blog:first-post"</li> </ul> </li> <li>returns: page properties as dictionary (consult documentation of <a href="/doc:listpages-module">ListPages module</a>) <ul> <li>all those listed in <tt>pages.get_meta</tt> plus:</li> <li>parent_title</li> <li>children</li> <li>content — page content, if page is assigned a form it's in YAML format</li> <li>html — generated HTML of the page (as seen from browser excluding navigational bars etc)</li> <li>comments — number of comments</li> <li>commented_at</li> <li>commented_by</li> </ul> </li> </ul> <div class="code"> <div class="hl-main"> <pre> >>> s.pages.get_one({"site": "my-site", "page": "blog:last-post"}) {"created_at": "2010-08-04T23:20:50Z", "created_by": "Gabrys", "updated_at": "2010-08-04T23:23:31Z", "updated_by": "Gabrys", "title": "Last Post", "parent_fullname": None, "tags": ["blog", "last"], "rating": 8, "revisions": 2, "parent_title": None, "children": 0, "content": "Test blog post", "html": "Test blog post", "comments": 0, "commented_at": None, "commented_by": None} </pre></div> </div> <h2 id="toc9">pages.save_one</h2> Save page. Site and page keys of argument array are required. Set specific keys to update the properties, omit to keep current values. <ul> <li>argument keys: <ul> <li>site: site to save page to</li> <li>page: page full name to save</li> <li>title (optional): title to set</li> <li>content (optional): page content — wiki source</li> <li>tags (optional): array of tags to set</li> <li>parent_fullname (optional): parent page full name, "-" to reset</li> <li>save_mode (optional): allowed mode of operation <ul> <li>create — only allow creating new objects (exception thrown if object with this name already exists)</li> <li>update — only allow updating objects (exception thrown if no object with this name exists)</li> <li>create_or_update (default) — allow both creating and updating object</li> </ul> </li> <li>rename_as (optional): rename the page (in addition to possible other changes in source etc)</li> <li>revision_comment (optional): revision comment (displayed in history)</li> <li>notify_watchers (optional): <ul> <li>true: notify watchers about the edit (as if it was done with the web interface)</li> <li>false (default): don't notify watchers</li> </ul> </li> </ul> </li> <li>returns: saved page (as in pages.get_one)</li> </ul> <div class="wiki-note"> We only want to make API for comments currently, but it will be expanded to both comments and forum. That's why the namespace is <tt>posts</tt> and not <tt>comments</tt>. Note the API for <tt>posts</tt> namespace is not yet stable. This means it may change in the future without notice and break compatibility. </div> <h2 id="toc10">posts.select</h2> Select post/comments on given site, page, thread and/or in reply to other comment. <ul> <li>argument keys: <ul> <li>site: site to get pages to get comments from, e.g. "my-site"</li> <li>page (optional): page to get comments from</li> <li>thread (optional): thread to get posts from — not yet implemented</li> <li>reply_to (optional): only select comments/posts that are direct replies to this one ("-" means not replies to other posts/comments)</li> <li>created_by (optional): select posts by this user</li> </ul> </li> <li>returns: list of post/comments IDs sorted by date posted</li> </ul> <h2 id="toc11">posts.get</h2> <ul> <li>argument keys: <ul> <li>site: site to get comments from, e.g. "my-site"</li> <li>posts: list of IDs of posts/comments to get (max 10 of them)</li> </ul> </li> <li>returns dictionary of posts/comments. For each post/comment there will be item in the dictionary with post/comment ID as key and and dictionary of the following post properties as value: <ul> <li>id — ID of post/comment</li> <li>fullname — fullname of page to which comment belongs</li> <li>reply_to — ID of comment which this post/comment replies to</li> <li>title — title of the post/comment</li> <li>content — post/comment body (wiki syntax)</li> <li>html — post/comment body as HTML</li> <li>created_by — user that posted post/comment</li> <li>created_at — time post/comment was posted</li> <li>replies — number of replies to given post/comment — not yet implemented</li> </ul> </li> </ul> <h2 id="toc12">users.get_me</h2> <ul> <li>argument keys: <ul> <li>no arguments needed, pass an empty dictionary or array</li> </ul> </li> <li>returns dictionary of user (the one that API key belongs to) properties: <ul> <li>name: URL version of user name, for example "john-smith" for "John Smith"</li> <li>title: full name of user, for example "John Smith"</li> <li>id: ID number of user, for example "12345"</li> </ul> </li> </ul> <h2 id="toc13">Deleted methods</h2> The following methods are deleted and don't work anymore: <ul> <li>site.pages</li> <li>site.categories</li> <li>page.get</li> <li>page.files</li> <li>page.save</li> <li>user.sites</li> </ul> </div><div id="action-area" style="display: none;"></div> </div> </div> </div> <div class="page-options-container container"> </div> </div> <div class="footer"> <div class="container"> <div class="row"> <div class="col-sm-6"><img src="https://www.wikidot.com/common--theme/wikidot30/images/amazon.png" alt="amazon.png" class="image" /></div> <div class="col-sm-3"> <a href="http://blog.wikidot.com">Official Wikidot blog</a> <a href="http://community.wikidot.com">Community</a> <a href="/doc">Documentation</a> </div> <div class="col-sm-3"> <a href="/about">About Wikidot</a> <a href="http://shop.wikidot.com">Gift Shop</a> <a href="/legal:terms-of-service">Terms of Service</a> <a href="/legal:privacy-policy">Privacy policy</a> </div> </div> </div> <div class="container license-area"> Copyright 漏 All Rights Reserved, Wikidot Inc. 2024 </div> </div> </div> <div id="dummy-ondomready-block" style="display: none;" ></div>  <script type="text/javascript"> (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'stats.g.doubleclick.net/dc.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> <div id="page-options-bottom-tips" style="display: none;"> <div id="edit-button-hovertip"> Click here to edit contents of this page. </div> </div> <div id="page-options-bottom-2-tips" style="display: none;"> <div id="edit-sections-button-hovertip"> Click here to toggle editing of individual sections of the page (if possible). Watch headings for an "edit" link when available. </div> <div id="edit-append-button-hovertip"> Append content without editing the whole page source. </div> <div id="history-button-hovertip"> Check out how this page has evolved in the past. </div> <div id="discuss-button-hovertip"> If you want to discuss contents of this page - this is the easiest way to do it. </div> <div id="files-button-hovertip"> View and manage file attachments for this page. </div> <div id="site-tools-button-hovertip"> A few useful tools to manage this Site. </div> <div id="backlinks-button-hovertip"> See pages that link to and include this page. </div> <div id="rename-move-button-hovertip"> Change the name (also URL address, possibly the category) of the page. </div> <div id="view-source-button-hovertip"> View wiki source for this page without editing. </div> <div id="parent-page-button-hovertip"> View/set parent page (used for creating breadcrumbs and structured layout). </div> </div> </body> </html>

CINXE.COM

Wikidot API - Wikidot - Free and Pro Wiki Hosting