1. Methods

• createAccount
• createPage
• editAccountInfo
• editPage
• getAccountInfo
• getPage
• getPageList
• getViews
• revokeAccessToken

2. Types

• Account
• Node
• NodeElement
• Page
• PageList
• PageViews

3. Content format

Available methods

createAccount

• short_name (String, 1-32 characters)
  Required. Account name, helps users with several accounts remember which they are currently using. Displayed to the user above the "Edit/Publish" button on Telegra.ph, other users don't see this name.
• author_name (String, 0-128 characters)
  Default author name used when creating new articles.
• author_url (String, 0-512 characters)
  Default profile link, opened when users click on the author's name below the title. Can be any link, not necessarily to a Telegram profile or channel.

Sample requesthttps://api.telegra.ph/createAccount?short_name=Sandbox&author_name=Anonymous

editAccountInfo

• access_token (String)
  Required. Access token of the Telegraph account.
• short_name (String, 1-32 characters)
  New account name.
• author_name (String, 0-128 characters)
  New default author name used when creating new articles.
• author_url (String, 0-512 characters)
  New default profile link, opened when users click on the author's name below the title. Can be any link, not necessarily to a Telegram profile or channel.

Sample requesthttps://api.telegra.ph/editAccountInfo?access_token=b968da509bb76866c35425099bc0989a5ec3b32997d55286c657e6994bbb&short_name=Sandbox&author_name=Anonymous

getAccountInfo

• access_token (String)
  Required. Access token of the Telegraph account.
• fields (Array of String, default = [“short_name”,“author_name”,“author_url”])
  List of account fields to return. Available fields: short_name, author_name, author_url, auth_url, page_count.

Sample requesthttps://api.telegra.ph/getAccountInfo?access_token=b968da509bb76866c35425099bc0989a5ec3b32997d55286c657e6994bbb&fields=["short_name","page_count"]

revokeAccessToken

• access_token (String)
  Required. Access token of the Telegraph account.

Sample requesthttps://api.telegra.ph/revokeAccessToken?access_token=b968da509bb76866c35425099bc0989a5ec3b32997d55286c657e6994bbb

createPage

• access_token (String)
  Required. Access token of the Telegraph account.
• title (String, 1-256 characters)
  Required. Page title.
• author_name (String, 0-128 characters)
  Author name, displayed below the article's title.
• author_url (String, 0-512 characters)
  Profile link, opened when users click on the author's name below the title. Can be any link, not necessarily to a Telegram profile or channel.
• content (Array of Node, up to 64 KB)
  Required. Content of the page.
• return_content (Boolean, default = false)
  If true, a content field will be returned in the Page object (see: Content format).

Sample requesthttps://api.telegra.ph/createPage?access_token=b968da509bb76866c35425099bc0989a5ec3b32997d55286c657e6994bbb&title=Sample+Page&author_name=Anonymous&content=[{"tag":"p","children":["Hello,+world!"]}]&return_content=true

editPage

• access_token (String)
  Required. Access token of the Telegraph account.
• path (String)
  Required. Path to the page.
• title (String, 1-256 characters)
  Required. Page title.
• content (Array of Node, up to 64 KB)
  Required. Content of the page.
• author_name (String, 0-128 characters)
  Author name, displayed below the article's title.
• author_url (String, 0-512 characters)
  Profile link, opened when users click on the author's name below the title. Can be any link, not necessarily to a Telegram profile or channel.
• return_content (Boolean, default = false)
  If true, a content field will be returned in the Page object.

Sample requesthttps://api.telegra.ph/editPage/Sample-Page-12-15?access_token=b968da509bb76866c35425099bc0989a5ec3b32997d55286c657e6994bbb&title=Sample+Page&author_name=Anonymous&content=[{"tag":"p","children":["Hello,+world!"]}]&return_content=true

getPage

• path (String)
  Required. Path to the Telegraph page (in the format Title-12-31, i.e. everything that comes after http://telegra.ph/).
• return_content (Boolean, default = false)
  If true, content field will be returned in Page object.

Sample requesthttps://api.telegra.ph/getPage/Sample-Page-12-15?return_content=true

getPageList

• access_token (String)
  Required. Access token of the Telegraph account.
• offset (Integer, default = 0)
  Sequential number of the first page to be returned.
• limit (Integer, 0-200, default = 50)
  Limits the number of pages to be retrieved.

Sample requesthttps://api.telegra.ph/getPageList?access_token=b968da509bb76866c35425099bc0989a5ec3b32997d55286c657e6994bbb&limit=3

getViews

• path (String)
  Required. Path to the Telegraph page (in the format Title-12-31, where 12 is the month and 31 the day the article was first published).
• year (Integer, 2000-2100)
  Required if month is passed. If passed, the number of page views for the requested year will be returned.
• month (Integer, 1-12)
  Required if day is passed. If passed, the number of page views for the requested month will be returned.
• day (Integer, 1-31)
  Required if hour is passed. If passed, the number of page views for the requested day will be returned.
• hour (Integer, 0-24)
  If passed, the number of page views for the requested hour will be returned.

Sample requesthttps://api.telegra.ph/getViews/Sample-Page-12-15?year=2016&month=12

Available types

Account

• short_name (String)
  Account name, helps users with several accounts remember which they are currently using. Displayed to the user above the "Edit/Publish" button on Telegra.ph, other users don't see this name.
• author_name (String)
  Default author name used when creating new articles.
• author_url (String)
  Profile link, opened when users click on the author's name below the title. Can be any link, not necessarily to a Telegram profile or channel.
• access_token (String)
  Optional. Only returned by the createAccount and revokeAccessToken method. Access token of the Telegraph account.
• auth_url (String)
  Optional. URL to authorize a browser on telegra.ph and connect it to a Telegraph account. This URL is valid for only one use and for 5 minutes only.
• page_count (Integer)
  Optional. Number of pages belonging to the Telegraph account.

PageList

• total_count (Integer)
  Total number of pages belonging to the target Telegraph account.
• pages (Array of Page)
  Requested pages of the target Telegraph account.

Page

• path (String)
  Path to the page.
• url (String)
  URL of the page.
• title (String)
  Title of the page.
• description (String)
  Description of the page.
• author_name (String)
  Optional. Name of the author, displayed below the title.
• author_url (String)
  Optional. Profile link, opened when users click on the author's name below the title. Can be any link, not necessarily to a Telegram profile or channel.
• image_url (String)
  Optional. Image URL of the page.
• content (Array of Node)
  Optional. Content of the page.
• views (Integer)
  Number of page views for the page.
• can_edit (Boolean)
  Optional. Only returned if access_token passed. True, if the target Telegraph account can edit the page.

PageViews

• views (Integer)
  Number of page views for the target page.

Node

NodeElement

• tag (String)
  Name of the DOM element. Available tags: a, aside, b, blockquote, br, code, em, figcaption, figure, h3, h4, hr, i, iframe, img, li, ol, p, pre, s, strong, u, ul, video.
• attrs (Object)
  Optional. Attributes of the DOM element. Key of object represents name of attribute, value represents value of attribute. Available attributes: href, src.
• children (Array of Node)
  Optional. List of child nodes for the DOM element.

Content format

function domToNode(domNode) {
  if (domNode.nodeType == domNode.TEXT_NODE) {
    return domNode.data;
  }
  if (domNode.nodeType != domNode.ELEMENT_NODE) {
    return false;
  }
  var nodeElement = {};
  nodeElement.tag = domNode.tagName.toLowerCase();
  for (var i = 0; i < domNode.attributes.length; i++) {
    var attr = domNode.attributes[i];
    if (attr.name == 'href' || attr.name == 'src') {
      if (!nodeElement.attrs) {
        nodeElement.attrs = {};
      }
      nodeElement.attrs[attr.name] = attr.value;
    }
  }
  if (domNode.childNodes.length > 0) {
    nodeElement.children = [];
    for (var i = 0; i < domNode.childNodes.length; i++) {
      var child = domNode.childNodes[i];
      nodeElement.children.push(domToNode(child));
    }
  }
  return nodeElement;
}

function nodeToDom(node) {
  if (typeof node === 'string' || node instanceof String) {
    return document.createTextNode(node);
  }
  if (node.tag) {
    var domNode = document.createElement(node.tag);
    if (node.attrs) {
      for (var name in node.attrs) {
        var value = node.attrs[name];
        domNode.setAttribute(name, value);
      }
    }
  } else {
    var domNode = document.createDocumentFragment();
  }
  if (node.children) {
    for (var i = 0; i < node.children.length; i++) {
      var child = node.children[i];
      domNode.appendChild(nodeToDom(child));
    }
  }
  return domNode;
}

var article = document.getElementById('article');
var content = domToNode(article).children;
$.ajax('https://api.telegra.ph/createPage', {
  data: {
    access_token:   '%access_token%',
    title:          'Title of page',
    content:        JSON.stringify(content),
    return_content: true
  },
  type: 'POST',
  dataType: 'json',
  success: function(data) {
    if (data.content) {
      while (article.firstChild) {
        article.removeChild(article.firstChild);
      }
      article.appendChild(nodeToDom({children: data.content}));
    }
  }
});