Files
api/docs/api/index.html
T
2019-02-28 13:02:48 +00:00

68 lines
50 KiB
HTML

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>polkadot-js/api</title>
<meta name="description" content="API libraries and interfaces for communicating with Polkadot and Substrate nodes">
<link rel="preload" href="/api/assets/css/0.styles.22f13802.css" as="style"><link rel="preload" href="/api/assets/js/app.ea488efd.js" as="script"><link rel="preload" href="/api/assets/js/2.16c7e4af.js" as="script"><link rel="preload" href="/api/assets/js/42.8407b7c4.js" as="script"><link rel="prefetch" href="/api/assets/js/10.730dd1f8.js"><link rel="prefetch" href="/api/assets/js/100.ca511823.js"><link rel="prefetch" href="/api/assets/js/101.553ffa55.js"><link rel="prefetch" href="/api/assets/js/102.0da1ec79.js"><link rel="prefetch" href="/api/assets/js/103.1f02833f.js"><link rel="prefetch" href="/api/assets/js/104.85ac0811.js"><link rel="prefetch" href="/api/assets/js/105.7e80c03b.js"><link rel="prefetch" href="/api/assets/js/106.5e6f31b1.js"><link rel="prefetch" href="/api/assets/js/107.5f08e115.js"><link rel="prefetch" href="/api/assets/js/108.643f37cd.js"><link rel="prefetch" href="/api/assets/js/109.2bfc3f88.js"><link rel="prefetch" href="/api/assets/js/11.16564673.js"><link rel="prefetch" href="/api/assets/js/110.391cd976.js"><link rel="prefetch" href="/api/assets/js/111.247898ab.js"><link rel="prefetch" href="/api/assets/js/112.1979bc80.js"><link rel="prefetch" href="/api/assets/js/113.4097126a.js"><link rel="prefetch" href="/api/assets/js/114.7c298e55.js"><link rel="prefetch" href="/api/assets/js/115.0568f994.js"><link rel="prefetch" href="/api/assets/js/116.7c28a393.js"><link rel="prefetch" href="/api/assets/js/117.bf1a2cc6.js"><link rel="prefetch" href="/api/assets/js/118.b1c65641.js"><link rel="prefetch" href="/api/assets/js/119.21ea0a94.js"><link rel="prefetch" href="/api/assets/js/12.23b26fea.js"><link rel="prefetch" href="/api/assets/js/120.32f79155.js"><link rel="prefetch" href="/api/assets/js/121.84147bfd.js"><link rel="prefetch" href="/api/assets/js/122.9d807a94.js"><link rel="prefetch" href="/api/assets/js/123.2a822b35.js"><link rel="prefetch" href="/api/assets/js/124.4e7f4672.js"><link rel="prefetch" href="/api/assets/js/125.2e967439.js"><link rel="prefetch" href="/api/assets/js/126.2f75633a.js"><link rel="prefetch" href="/api/assets/js/127.6a1e1746.js"><link rel="prefetch" href="/api/assets/js/128.7cff7178.js"><link rel="prefetch" href="/api/assets/js/129.ea33f5cb.js"><link rel="prefetch" href="/api/assets/js/13.89e4dbaf.js"><link rel="prefetch" href="/api/assets/js/130.3c5e03a1.js"><link rel="prefetch" href="/api/assets/js/131.dcf81ac8.js"><link rel="prefetch" href="/api/assets/js/132.cfdf6b8f.js"><link rel="prefetch" href="/api/assets/js/133.1a7accd7.js"><link rel="prefetch" href="/api/assets/js/134.402b574e.js"><link rel="prefetch" href="/api/assets/js/135.7dd6b4db.js"><link rel="prefetch" href="/api/assets/js/136.9dcd2366.js"><link rel="prefetch" href="/api/assets/js/137.cdee1656.js"><link rel="prefetch" href="/api/assets/js/138.39184086.js"><link rel="prefetch" href="/api/assets/js/139.f90df65f.js"><link rel="prefetch" href="/api/assets/js/14.8212f44f.js"><link rel="prefetch" href="/api/assets/js/140.df0fdbee.js"><link rel="prefetch" href="/api/assets/js/141.3ac35658.js"><link rel="prefetch" href="/api/assets/js/142.b2cceeea.js"><link rel="prefetch" href="/api/assets/js/143.580c8451.js"><link rel="prefetch" href="/api/assets/js/144.68e753bb.js"><link rel="prefetch" href="/api/assets/js/145.340cc950.js"><link rel="prefetch" href="/api/assets/js/146.cf86a887.js"><link rel="prefetch" href="/api/assets/js/147.e8467d58.js"><link rel="prefetch" href="/api/assets/js/148.d62977b0.js"><link rel="prefetch" href="/api/assets/js/149.4423ac17.js"><link rel="prefetch" href="/api/assets/js/15.d8a6af32.js"><link rel="prefetch" href="/api/assets/js/150.27c79c1e.js"><link rel="prefetch" href="/api/assets/js/151.f45a01cd.js"><link rel="prefetch" href="/api/assets/js/152.9e0ddfd2.js"><link rel="prefetch" href="/api/assets/js/153.dd79521c.js"><link rel="prefetch" href="/api/assets/js/154.d684ed56.js"><link rel="prefetch" href="/api/assets/js/155.132e736b.js"><link rel="prefetch" href="/api/assets/js/156.7375610d.js"><link rel="prefetch" href="/api/assets/js/157.3015cd77.js"><link rel="prefetch" href="/api/assets/js/158.3fdd4c6d.js"><link rel="prefetch" href="/api/assets/js/159.3879d14f.js"><link rel="prefetch" href="/api/assets/js/16.40151e05.js"><link rel="prefetch" href="/api/assets/js/160.2187440a.js"><link rel="prefetch" href="/api/assets/js/161.680a3a2c.js"><link rel="prefetch" href="/api/assets/js/162.0715e720.js"><link rel="prefetch" href="/api/assets/js/163.13f3ff17.js"><link rel="prefetch" href="/api/assets/js/164.729efdb3.js"><link rel="prefetch" href="/api/assets/js/165.d4599569.js"><link rel="prefetch" href="/api/assets/js/166.1d7b1fd8.js"><link rel="prefetch" href="/api/assets/js/167.67c476d6.js"><link rel="prefetch" href="/api/assets/js/168.1a2681d6.js"><link rel="prefetch" href="/api/assets/js/169.6f182405.js"><link rel="prefetch" href="/api/assets/js/17.0cadbbe1.js"><link rel="prefetch" href="/api/assets/js/170.e5a9cf81.js"><link rel="prefetch" href="/api/assets/js/171.0fa7c9d5.js"><link rel="prefetch" href="/api/assets/js/172.ea468e02.js"><link rel="prefetch" href="/api/assets/js/173.0b544598.js"><link rel="prefetch" href="/api/assets/js/174.9ab8554e.js"><link rel="prefetch" href="/api/assets/js/175.9c2273db.js"><link rel="prefetch" href="/api/assets/js/176.c8ca0f49.js"><link rel="prefetch" href="/api/assets/js/177.5fa49e5c.js"><link rel="prefetch" href="/api/assets/js/178.85753470.js"><link rel="prefetch" href="/api/assets/js/179.33c19c3b.js"><link rel="prefetch" href="/api/assets/js/18.714d6145.js"><link rel="prefetch" href="/api/assets/js/180.f41fbd45.js"><link rel="prefetch" href="/api/assets/js/181.3cbec004.js"><link rel="prefetch" href="/api/assets/js/182.be73a590.js"><link rel="prefetch" href="/api/assets/js/183.97ea8694.js"><link rel="prefetch" href="/api/assets/js/184.f5c4d39a.js"><link rel="prefetch" href="/api/assets/js/185.63a044a8.js"><link rel="prefetch" href="/api/assets/js/186.edf6b277.js"><link rel="prefetch" href="/api/assets/js/187.5c94433e.js"><link rel="prefetch" href="/api/assets/js/188.7c0aa44e.js"><link rel="prefetch" href="/api/assets/js/189.21bc2a5f.js"><link rel="prefetch" href="/api/assets/js/19.ea56dec0.js"><link rel="prefetch" href="/api/assets/js/190.58531b65.js"><link rel="prefetch" href="/api/assets/js/191.1c94ebe3.js"><link rel="prefetch" href="/api/assets/js/192.91f2c9a1.js"><link rel="prefetch" href="/api/assets/js/193.917b4055.js"><link rel="prefetch" href="/api/assets/js/194.ae691468.js"><link rel="prefetch" href="/api/assets/js/195.a6b48df0.js"><link rel="prefetch" href="/api/assets/js/196.87f89edc.js"><link rel="prefetch" href="/api/assets/js/197.c36f7ea4.js"><link rel="prefetch" href="/api/assets/js/198.525a4b7d.js"><link rel="prefetch" href="/api/assets/js/199.5015f2d3.js"><link rel="prefetch" href="/api/assets/js/20.0e054b48.js"><link rel="prefetch" href="/api/assets/js/200.75faeee9.js"><link rel="prefetch" href="/api/assets/js/201.44b6271a.js"><link rel="prefetch" href="/api/assets/js/202.dfcfe327.js"><link rel="prefetch" href="/api/assets/js/203.398e2047.js"><link rel="prefetch" href="/api/assets/js/204.d9b4f519.js"><link rel="prefetch" href="/api/assets/js/205.2657056f.js"><link rel="prefetch" href="/api/assets/js/206.e65453db.js"><link rel="prefetch" href="/api/assets/js/207.4de69828.js"><link rel="prefetch" href="/api/assets/js/208.984d51cb.js"><link rel="prefetch" href="/api/assets/js/209.643919d7.js"><link rel="prefetch" href="/api/assets/js/21.60f7dc48.js"><link rel="prefetch" href="/api/assets/js/210.b211216d.js"><link rel="prefetch" href="/api/assets/js/211.1efecaad.js"><link rel="prefetch" href="/api/assets/js/212.5126bb85.js"><link rel="prefetch" href="/api/assets/js/213.cf3debe0.js"><link rel="prefetch" href="/api/assets/js/214.a852db4b.js"><link rel="prefetch" href="/api/assets/js/215.958e2264.js"><link rel="prefetch" href="/api/assets/js/216.96259efd.js"><link rel="prefetch" href="/api/assets/js/217.814d497f.js"><link rel="prefetch" href="/api/assets/js/218.2b543c38.js"><link rel="prefetch" href="/api/assets/js/219.cac05f6f.js"><link rel="prefetch" href="/api/assets/js/22.a7728bb5.js"><link rel="prefetch" href="/api/assets/js/220.ba0f1b57.js"><link rel="prefetch" href="/api/assets/js/221.69960261.js"><link rel="prefetch" href="/api/assets/js/222.16028c06.js"><link rel="prefetch" href="/api/assets/js/223.e16c683c.js"><link rel="prefetch" href="/api/assets/js/224.c038df2b.js"><link rel="prefetch" href="/api/assets/js/225.7df2d9f2.js"><link rel="prefetch" href="/api/assets/js/226.4c36f1be.js"><link rel="prefetch" href="/api/assets/js/227.9a2401b9.js"><link rel="prefetch" href="/api/assets/js/228.1b9fb659.js"><link rel="prefetch" href="/api/assets/js/229.1e4a771a.js"><link rel="prefetch" href="/api/assets/js/23.b30fdfff.js"><link rel="prefetch" href="/api/assets/js/230.73c4c7fc.js"><link rel="prefetch" href="/api/assets/js/231.e7c0d9a5.js"><link rel="prefetch" href="/api/assets/js/232.5648aca5.js"><link rel="prefetch" href="/api/assets/js/233.b647f4f0.js"><link rel="prefetch" href="/api/assets/js/234.868104fc.js"><link rel="prefetch" href="/api/assets/js/235.ecd00231.js"><link rel="prefetch" href="/api/assets/js/236.ac517b92.js"><link rel="prefetch" href="/api/assets/js/237.06cb3f91.js"><link rel="prefetch" href="/api/assets/js/238.6cb64904.js"><link rel="prefetch" href="/api/assets/js/239.63a6f16d.js"><link rel="prefetch" href="/api/assets/js/24.0868fa0c.js"><link rel="prefetch" href="/api/assets/js/240.c384fb29.js"><link rel="prefetch" href="/api/assets/js/241.cf9360a5.js"><link rel="prefetch" href="/api/assets/js/242.8ddb5516.js"><link rel="prefetch" href="/api/assets/js/243.9ef77bc3.js"><link rel="prefetch" href="/api/assets/js/244.0ccec493.js"><link rel="prefetch" href="/api/assets/js/245.d2970f61.js"><link rel="prefetch" href="/api/assets/js/246.964b56ca.js"><link rel="prefetch" href="/api/assets/js/247.fe054aa5.js"><link rel="prefetch" href="/api/assets/js/248.3616d6f4.js"><link rel="prefetch" href="/api/assets/js/249.4b683772.js"><link rel="prefetch" href="/api/assets/js/25.c9768e23.js"><link rel="prefetch" href="/api/assets/js/250.73e40a70.js"><link rel="prefetch" href="/api/assets/js/251.7558f2ea.js"><link rel="prefetch" href="/api/assets/js/252.15f2dfec.js"><link rel="prefetch" href="/api/assets/js/253.95cd7122.js"><link rel="prefetch" href="/api/assets/js/254.b0b505a9.js"><link rel="prefetch" href="/api/assets/js/255.cbeb6d0d.js"><link rel="prefetch" href="/api/assets/js/256.aebda57b.js"><link rel="prefetch" href="/api/assets/js/257.6c8ec712.js"><link rel="prefetch" href="/api/assets/js/258.87f76ceb.js"><link rel="prefetch" href="/api/assets/js/259.2e0368b6.js"><link rel="prefetch" href="/api/assets/js/26.7808132a.js"><link rel="prefetch" href="/api/assets/js/260.2248090b.js"><link rel="prefetch" href="/api/assets/js/261.08c9df99.js"><link rel="prefetch" href="/api/assets/js/262.3ff926a4.js"><link rel="prefetch" href="/api/assets/js/263.45570ce9.js"><link rel="prefetch" href="/api/assets/js/264.41f7177f.js"><link rel="prefetch" href="/api/assets/js/265.a1c048fa.js"><link rel="prefetch" href="/api/assets/js/266.3c3e4de7.js"><link rel="prefetch" href="/api/assets/js/267.3098152d.js"><link rel="prefetch" href="/api/assets/js/268.6741a34e.js"><link rel="prefetch" href="/api/assets/js/269.1fd28d56.js"><link rel="prefetch" href="/api/assets/js/27.fe4b5c14.js"><link rel="prefetch" href="/api/assets/js/270.dcc22e3a.js"><link rel="prefetch" href="/api/assets/js/271.3e4a008a.js"><link rel="prefetch" href="/api/assets/js/272.8d20003e.js"><link rel="prefetch" href="/api/assets/js/273.d3ba5b3e.js"><link rel="prefetch" href="/api/assets/js/274.5faf4627.js"><link rel="prefetch" href="/api/assets/js/275.6ce9fcd9.js"><link rel="prefetch" href="/api/assets/js/276.086d7309.js"><link rel="prefetch" href="/api/assets/js/277.136cb807.js"><link rel="prefetch" href="/api/assets/js/278.9218f102.js"><link rel="prefetch" href="/api/assets/js/279.293915b9.js"><link rel="prefetch" href="/api/assets/js/28.83f8aa65.js"><link rel="prefetch" href="/api/assets/js/280.7f0bf3fd.js"><link rel="prefetch" href="/api/assets/js/281.e4381f47.js"><link rel="prefetch" href="/api/assets/js/282.607fde22.js"><link rel="prefetch" href="/api/assets/js/283.ac798380.js"><link rel="prefetch" href="/api/assets/js/284.007fd642.js"><link rel="prefetch" href="/api/assets/js/285.b84294e3.js"><link rel="prefetch" href="/api/assets/js/286.c64351b3.js"><link rel="prefetch" href="/api/assets/js/287.d27f6e11.js"><link rel="prefetch" href="/api/assets/js/288.ac370bde.js"><link rel="prefetch" href="/api/assets/js/289.e7d1422e.js"><link rel="prefetch" href="/api/assets/js/29.47b5be8d.js"><link rel="prefetch" href="/api/assets/js/290.0a031606.js"><link rel="prefetch" href="/api/assets/js/291.8de8ff06.js"><link rel="prefetch" href="/api/assets/js/292.bb0ea38c.js"><link rel="prefetch" href="/api/assets/js/293.52eda1cd.js"><link rel="prefetch" href="/api/assets/js/294.2cacd6cf.js"><link rel="prefetch" href="/api/assets/js/295.7fe48d44.js"><link rel="prefetch" href="/api/assets/js/296.f61c2c00.js"><link rel="prefetch" href="/api/assets/js/297.c1127367.js"><link rel="prefetch" href="/api/assets/js/298.b924b2b9.js"><link rel="prefetch" href="/api/assets/js/299.932c15ac.js"><link rel="prefetch" href="/api/assets/js/3.04cf2d04.js"><link rel="prefetch" href="/api/assets/js/30.a8182388.js"><link rel="prefetch" href="/api/assets/js/300.d570b029.js"><link rel="prefetch" href="/api/assets/js/301.019d11c7.js"><link rel="prefetch" href="/api/assets/js/302.c611b601.js"><link rel="prefetch" href="/api/assets/js/303.a376d327.js"><link rel="prefetch" href="/api/assets/js/304.5f0cff90.js"><link rel="prefetch" href="/api/assets/js/305.63e74ee3.js"><link rel="prefetch" href="/api/assets/js/306.cca22ee6.js"><link rel="prefetch" href="/api/assets/js/307.c95b53d7.js"><link rel="prefetch" href="/api/assets/js/308.5fda621d.js"><link rel="prefetch" href="/api/assets/js/309.9b876058.js"><link rel="prefetch" href="/api/assets/js/31.f46c7404.js"><link rel="prefetch" href="/api/assets/js/310.419a700f.js"><link rel="prefetch" href="/api/assets/js/311.f8af589d.js"><link rel="prefetch" href="/api/assets/js/312.2450b227.js"><link rel="prefetch" href="/api/assets/js/313.b9009865.js"><link rel="prefetch" href="/api/assets/js/314.53a72f42.js"><link rel="prefetch" href="/api/assets/js/315.984b43a5.js"><link rel="prefetch" href="/api/assets/js/316.0c709a9e.js"><link rel="prefetch" href="/api/assets/js/317.60e8df6c.js"><link rel="prefetch" href="/api/assets/js/318.c630d384.js"><link rel="prefetch" href="/api/assets/js/319.b2671ca4.js"><link rel="prefetch" href="/api/assets/js/32.d1cfa31f.js"><link rel="prefetch" href="/api/assets/js/320.afbbd029.js"><link rel="prefetch" href="/api/assets/js/321.339d71c2.js"><link rel="prefetch" href="/api/assets/js/322.e9f5bb56.js"><link rel="prefetch" href="/api/assets/js/323.18234317.js"><link rel="prefetch" href="/api/assets/js/324.876d6fa4.js"><link rel="prefetch" href="/api/assets/js/325.760b9745.js"><link rel="prefetch" href="/api/assets/js/326.6d4fa02d.js"><link rel="prefetch" href="/api/assets/js/327.281fe456.js"><link rel="prefetch" href="/api/assets/js/328.c5495c85.js"><link rel="prefetch" href="/api/assets/js/329.ed360faa.js"><link rel="prefetch" href="/api/assets/js/33.8a0e0669.js"><link rel="prefetch" href="/api/assets/js/330.f19292df.js"><link rel="prefetch" href="/api/assets/js/331.4c61687a.js"><link rel="prefetch" href="/api/assets/js/332.a3d97398.js"><link rel="prefetch" href="/api/assets/js/333.59e4acd9.js"><link rel="prefetch" href="/api/assets/js/334.50b4fc9a.js"><link rel="prefetch" href="/api/assets/js/335.8601cab4.js"><link rel="prefetch" href="/api/assets/js/336.e5fe146e.js"><link rel="prefetch" href="/api/assets/js/337.34dc215b.js"><link rel="prefetch" href="/api/assets/js/338.e2dbfeee.js"><link rel="prefetch" href="/api/assets/js/339.86dcca2a.js"><link rel="prefetch" href="/api/assets/js/34.b504662f.js"><link rel="prefetch" href="/api/assets/js/340.fb493bcb.js"><link rel="prefetch" href="/api/assets/js/341.7793a420.js"><link rel="prefetch" href="/api/assets/js/342.894cba5f.js"><link rel="prefetch" href="/api/assets/js/343.808d0d4b.js"><link rel="prefetch" href="/api/assets/js/344.c80cd4fa.js"><link rel="prefetch" href="/api/assets/js/345.7c227d05.js"><link rel="prefetch" href="/api/assets/js/346.b1f040e3.js"><link rel="prefetch" href="/api/assets/js/347.b45f5f70.js"><link rel="prefetch" href="/api/assets/js/348.111d9030.js"><link rel="prefetch" href="/api/assets/js/349.beab680d.js"><link rel="prefetch" href="/api/assets/js/35.7026463c.js"><link rel="prefetch" href="/api/assets/js/350.dd8e26c9.js"><link rel="prefetch" href="/api/assets/js/351.d5d29456.js"><link rel="prefetch" href="/api/assets/js/352.4ca1680f.js"><link rel="prefetch" href="/api/assets/js/353.a00d14f4.js"><link rel="prefetch" href="/api/assets/js/354.f8abebf6.js"><link rel="prefetch" href="/api/assets/js/355.7bf4ffd3.js"><link rel="prefetch" href="/api/assets/js/356.8c59d551.js"><link rel="prefetch" href="/api/assets/js/357.8b269634.js"><link rel="prefetch" href="/api/assets/js/358.0d9fae89.js"><link rel="prefetch" href="/api/assets/js/359.1864fd51.js"><link rel="prefetch" href="/api/assets/js/36.83308d7e.js"><link rel="prefetch" href="/api/assets/js/360.995c1f87.js"><link rel="prefetch" href="/api/assets/js/361.07f86df7.js"><link rel="prefetch" href="/api/assets/js/362.2377269e.js"><link rel="prefetch" href="/api/assets/js/363.a7e04d3f.js"><link rel="prefetch" href="/api/assets/js/364.3a087e99.js"><link rel="prefetch" href="/api/assets/js/365.7e7081ca.js"><link rel="prefetch" href="/api/assets/js/366.d6ed06a5.js"><link rel="prefetch" href="/api/assets/js/367.1ed3b875.js"><link rel="prefetch" href="/api/assets/js/368.2726ec3d.js"><link rel="prefetch" href="/api/assets/js/369.be7a251d.js"><link rel="prefetch" href="/api/assets/js/37.1b12964f.js"><link rel="prefetch" href="/api/assets/js/370.d728c50e.js"><link rel="prefetch" href="/api/assets/js/371.1221fd08.js"><link rel="prefetch" href="/api/assets/js/372.ed7d2826.js"><link rel="prefetch" href="/api/assets/js/373.3a75111b.js"><link rel="prefetch" href="/api/assets/js/374.e62cbb4c.js"><link rel="prefetch" href="/api/assets/js/375.91881f5b.js"><link rel="prefetch" href="/api/assets/js/376.1db690d5.js"><link rel="prefetch" href="/api/assets/js/377.de5d9945.js"><link rel="prefetch" href="/api/assets/js/378.66e8da8f.js"><link rel="prefetch" href="/api/assets/js/379.a33060cc.js"><link rel="prefetch" href="/api/assets/js/38.6e2028aa.js"><link rel="prefetch" href="/api/assets/js/380.b99b07cb.js"><link rel="prefetch" href="/api/assets/js/381.ecdccf3b.js"><link rel="prefetch" href="/api/assets/js/382.74ce6934.js"><link rel="prefetch" href="/api/assets/js/383.b2df99e3.js"><link rel="prefetch" href="/api/assets/js/384.3340f275.js"><link rel="prefetch" href="/api/assets/js/385.d812add9.js"><link rel="prefetch" href="/api/assets/js/386.88818459.js"><link rel="prefetch" href="/api/assets/js/387.6ca2ea8e.js"><link rel="prefetch" href="/api/assets/js/388.2a85b4d3.js"><link rel="prefetch" href="/api/assets/js/389.32e60d49.js"><link rel="prefetch" href="/api/assets/js/39.2ef37369.js"><link rel="prefetch" href="/api/assets/js/390.bf318495.js"><link rel="prefetch" href="/api/assets/js/391.93d6b009.js"><link rel="prefetch" href="/api/assets/js/392.5b3ed9eb.js"><link rel="prefetch" href="/api/assets/js/393.129cca6c.js"><link rel="prefetch" href="/api/assets/js/394.e51c5ace.js"><link rel="prefetch" href="/api/assets/js/395.f2f04b18.js"><link rel="prefetch" href="/api/assets/js/396.1fd42ede.js"><link rel="prefetch" href="/api/assets/js/397.c1813965.js"><link rel="prefetch" href="/api/assets/js/398.32eb13aa.js"><link rel="prefetch" href="/api/assets/js/399.795446a3.js"><link rel="prefetch" href="/api/assets/js/4.adbf2d29.js"><link rel="prefetch" href="/api/assets/js/40.49c833ce.js"><link rel="prefetch" href="/api/assets/js/400.f6ece95d.js"><link rel="prefetch" href="/api/assets/js/401.0002d8cf.js"><link rel="prefetch" href="/api/assets/js/402.dd239bd6.js"><link rel="prefetch" href="/api/assets/js/403.162a25a1.js"><link rel="prefetch" href="/api/assets/js/404.cd26d08b.js"><link rel="prefetch" href="/api/assets/js/405.41d2d800.js"><link rel="prefetch" href="/api/assets/js/406.b4c405ad.js"><link rel="prefetch" href="/api/assets/js/407.1482cae8.js"><link rel="prefetch" href="/api/assets/js/408.b826a189.js"><link rel="prefetch" href="/api/assets/js/409.be518933.js"><link rel="prefetch" href="/api/assets/js/41.0e6ea377.js"><link rel="prefetch" href="/api/assets/js/410.86fff13b.js"><link rel="prefetch" href="/api/assets/js/411.6c670c0f.js"><link rel="prefetch" href="/api/assets/js/412.8092ef28.js"><link rel="prefetch" href="/api/assets/js/413.19be8b54.js"><link rel="prefetch" href="/api/assets/js/414.76493004.js"><link rel="prefetch" href="/api/assets/js/415.bdff2d2d.js"><link rel="prefetch" href="/api/assets/js/416.889eb219.js"><link rel="prefetch" href="/api/assets/js/417.534b13ab.js"><link rel="prefetch" href="/api/assets/js/418.d43b51b8.js"><link rel="prefetch" href="/api/assets/js/419.e38eec68.js"><link rel="prefetch" href="/api/assets/js/420.bf13b289.js"><link rel="prefetch" href="/api/assets/js/421.616046f6.js"><link rel="prefetch" href="/api/assets/js/422.3933effc.js"><link rel="prefetch" href="/api/assets/js/423.21e1d41f.js"><link rel="prefetch" href="/api/assets/js/424.c7c086b6.js"><link rel="prefetch" href="/api/assets/js/425.54913cd2.js"><link rel="prefetch" href="/api/assets/js/426.a7fed113.js"><link rel="prefetch" href="/api/assets/js/427.7f371c22.js"><link rel="prefetch" href="/api/assets/js/428.08745b54.js"><link rel="prefetch" href="/api/assets/js/429.d20bd9c7.js"><link rel="prefetch" href="/api/assets/js/43.5f2da7c0.js"><link rel="prefetch" href="/api/assets/js/430.f2cbef53.js"><link rel="prefetch" href="/api/assets/js/431.42063ff2.js"><link rel="prefetch" href="/api/assets/js/432.b47603bf.js"><link rel="prefetch" href="/api/assets/js/433.4f152866.js"><link rel="prefetch" href="/api/assets/js/434.cd85ac32.js"><link rel="prefetch" href="/api/assets/js/435.55e8c3a4.js"><link rel="prefetch" href="/api/assets/js/436.b77a1376.js"><link rel="prefetch" href="/api/assets/js/437.69537313.js"><link rel="prefetch" href="/api/assets/js/438.6258626a.js"><link rel="prefetch" href="/api/assets/js/439.233d0a88.js"><link rel="prefetch" href="/api/assets/js/44.8aeba118.js"><link rel="prefetch" href="/api/assets/js/440.ddb31beb.js"><link rel="prefetch" href="/api/assets/js/441.4822f02c.js"><link rel="prefetch" href="/api/assets/js/442.b941fe1e.js"><link rel="prefetch" href="/api/assets/js/443.4cf74cfd.js"><link rel="prefetch" href="/api/assets/js/444.c39a1007.js"><link rel="prefetch" href="/api/assets/js/445.03050f12.js"><link rel="prefetch" href="/api/assets/js/446.889f7a8c.js"><link rel="prefetch" href="/api/assets/js/447.2ec94099.js"><link rel="prefetch" href="/api/assets/js/448.162c943f.js"><link rel="prefetch" href="/api/assets/js/449.9d0db40b.js"><link rel="prefetch" href="/api/assets/js/45.c2214929.js"><link rel="prefetch" href="/api/assets/js/450.5083ce7e.js"><link rel="prefetch" href="/api/assets/js/451.11fca1f7.js"><link rel="prefetch" href="/api/assets/js/452.5d4a004c.js"><link rel="prefetch" href="/api/assets/js/453.a8206442.js"><link rel="prefetch" href="/api/assets/js/454.3040d79f.js"><link rel="prefetch" href="/api/assets/js/455.e3040085.js"><link rel="prefetch" href="/api/assets/js/456.4e7ac5cc.js"><link rel="prefetch" href="/api/assets/js/457.99bd9def.js"><link rel="prefetch" href="/api/assets/js/458.135f5897.js"><link rel="prefetch" href="/api/assets/js/459.65aeb544.js"><link rel="prefetch" href="/api/assets/js/46.94e69ce6.js"><link rel="prefetch" href="/api/assets/js/460.46c9c6c5.js"><link rel="prefetch" href="/api/assets/js/47.f9256cd5.js"><link rel="prefetch" href="/api/assets/js/48.38486aa1.js"><link rel="prefetch" href="/api/assets/js/49.9d343381.js"><link rel="prefetch" href="/api/assets/js/5.45a9bb87.js"><link rel="prefetch" href="/api/assets/js/50.5fe10ce8.js"><link rel="prefetch" href="/api/assets/js/51.02b977ea.js"><link rel="prefetch" href="/api/assets/js/52.55f294e3.js"><link rel="prefetch" href="/api/assets/js/53.49b9b3f7.js"><link rel="prefetch" href="/api/assets/js/54.4b6f6495.js"><link rel="prefetch" href="/api/assets/js/55.0768babe.js"><link rel="prefetch" href="/api/assets/js/56.a6db3bce.js"><link rel="prefetch" href="/api/assets/js/57.8437eb37.js"><link rel="prefetch" href="/api/assets/js/58.fa6e99dd.js"><link rel="prefetch" href="/api/assets/js/59.09d0c438.js"><link rel="prefetch" href="/api/assets/js/6.faddde38.js"><link rel="prefetch" href="/api/assets/js/60.873c4917.js"><link rel="prefetch" href="/api/assets/js/61.18b20d40.js"><link rel="prefetch" href="/api/assets/js/62.5e5f1d72.js"><link rel="prefetch" href="/api/assets/js/63.2de916c2.js"><link rel="prefetch" href="/api/assets/js/64.afd165df.js"><link rel="prefetch" href="/api/assets/js/65.ee2bfa33.js"><link rel="prefetch" href="/api/assets/js/66.9c6a9f66.js"><link rel="prefetch" href="/api/assets/js/67.ff49dc36.js"><link rel="prefetch" href="/api/assets/js/68.1de2396b.js"><link rel="prefetch" href="/api/assets/js/69.9e892d0b.js"><link rel="prefetch" href="/api/assets/js/7.7d20a020.js"><link rel="prefetch" href="/api/assets/js/70.0fa5cf88.js"><link rel="prefetch" href="/api/assets/js/71.906dbe9f.js"><link rel="prefetch" href="/api/assets/js/72.77fd6d42.js"><link rel="prefetch" href="/api/assets/js/73.efcf09f8.js"><link rel="prefetch" href="/api/assets/js/74.22a477fd.js"><link rel="prefetch" href="/api/assets/js/75.9e613539.js"><link rel="prefetch" href="/api/assets/js/76.fc057215.js"><link rel="prefetch" href="/api/assets/js/77.d2c78482.js"><link rel="prefetch" href="/api/assets/js/78.51114efa.js"><link rel="prefetch" href="/api/assets/js/79.d40e5274.js"><link rel="prefetch" href="/api/assets/js/8.91aa366b.js"><link rel="prefetch" href="/api/assets/js/80.947f0d3e.js"><link rel="prefetch" href="/api/assets/js/81.e243d073.js"><link rel="prefetch" href="/api/assets/js/82.95e1e9ef.js"><link rel="prefetch" href="/api/assets/js/83.78169173.js"><link rel="prefetch" href="/api/assets/js/84.4a6dfa97.js"><link rel="prefetch" href="/api/assets/js/85.531e272e.js"><link rel="prefetch" href="/api/assets/js/86.b95e8133.js"><link rel="prefetch" href="/api/assets/js/87.d8fdeb9d.js"><link rel="prefetch" href="/api/assets/js/88.18d0ae4f.js"><link rel="prefetch" href="/api/assets/js/89.0611fea1.js"><link rel="prefetch" href="/api/assets/js/9.a28c3096.js"><link rel="prefetch" href="/api/assets/js/90.0eda8f57.js"><link rel="prefetch" href="/api/assets/js/91.8bbc3dd9.js"><link rel="prefetch" href="/api/assets/js/92.f2a6b3f4.js"><link rel="prefetch" href="/api/assets/js/93.d506ddb5.js"><link rel="prefetch" href="/api/assets/js/94.22bb7e14.js"><link rel="prefetch" href="/api/assets/js/95.6985ab8e.js"><link rel="prefetch" href="/api/assets/js/96.2378ec2d.js"><link rel="prefetch" href="/api/assets/js/97.1402a4d4.js"><link rel="prefetch" href="/api/assets/js/98.e668802c.js"><link rel="prefetch" href="/api/assets/js/99.6746c5ca.js">
<link rel="stylesheet" href="/api/assets/css/0.styles.22f13802.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/api/" class="home-link router-link-active"><!----> <span class="site-name">polkadot-js/api</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="https://github.com/polkadot-js/api" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="https://github.com/polkadot-js/api" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><a href="/api/examples/promise/" class="sidebar-heading clickable open"><span>Examples (Promise API)</span> <!----></a> <ul class="sidebar-links sidebar-group-items"><li><a href="/api/examples/promise/01_simple_connect/" class="sidebar-link">Simple connect</a></li><li><a href="/api/examples/promise/02_listen_to_blocks/" class="sidebar-link">Listen to blocks</a></li><li><a href="/api/examples/promise/03_listen_to_balance_change/" class="sidebar-link">Listen to balance change</a></li><li><a href="/api/examples/promise/04_unsubscribe/" class="sidebar-link">Unsubscribe from listening</a></li><li><a href="/api/examples/promise/05_read_storage/" class="sidebar-link">Read chain state</a></li><li><a href="/api/examples/promise/06_make_transfer/" class="sidebar-link">Make a transfer</a></li><li><a href="/api/examples/promise/08_system_events/" class="sidebar-link">Display system events</a></li><li><a href="/api/examples/promise/09_transfer_events/" class="sidebar-link">Transaction with events</a></li><li><a href="/api/examples/promise/10_upgrade_chain/" class="sidebar-link">Upgrade via sudo</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Substrate interfaces</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/api/METHODS_RPC.html" class="sidebar-link">Substrate RPC</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/api/METHODS_RPC.html#json-rpc" class="sidebar-link">JSON-RPC</a></li></ul></li><li><a href="/api/METHODS_STORAGE.html" class="sidebar-link">State storage (defaults)</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/api/METHODS_STORAGE.html#storage" class="sidebar-link">Storage</a></li></ul></li><li><a href="/api/METHODS_EXTRINSICS.html" class="sidebar-link">Extrinsics (defaults)</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/api/METHODS_EXTRINSICS.html#extrinsics" class="sidebar-link">Extrinsics</a></li></ul></li><li><a href="/api/METHODS_EVENTS.html" class="sidebar-link">System events (defaults)</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/api/METHODS_EVENTS.html#events" class="sidebar-link">Events</a></li></ul></li></ul></section></li><li><a href="/api/api/" class="active sidebar-link">@polkadot/api</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/api/api/#api-selection" class="sidebar-link">API Selection</a></li><li class="sidebar-sub-header"><a href="/api/api/#dynamic-by-default" class="sidebar-link">Dynamic by default</a></li><li class="sidebar-sub-header"><a href="/api/api/#installation-import" class="sidebar-link">Installation &amp; import</a></li><li class="sidebar-sub-header"><a href="/api/api/#registering-custom-types" class="sidebar-link">Registering custom types</a></li><li class="sidebar-sub-header"><a href="/api/api/#users" class="sidebar-link">Users</a></li><li class="sidebar-sub-header"><a href="/api/api/#classes" class="sidebar-link">Classes</a></li></ul></li><li><a href="/api/types/" class="sidebar-link">@polkadot/types</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/api/types/#primitive-types" class="sidebar-link">Primitive types</a></li><li class="sidebar-sub-header"><a href="/api/types/#substrate-types" class="sidebar-link">Substrate types</a></li><li class="sidebar-sub-header"><a href="/api/types/#codec-types" class="sidebar-link">Codec types</a></li><li class="sidebar-sub-header"><a href="/api/types/#rpc-types" class="sidebar-link">RPC types</a></li><li class="sidebar-sub-header"><a href="/api/types/#derived-types" class="sidebar-link">Derived types</a></li></ul></li><li><a href="/api/CONTRIBUTING.html" class="sidebar-link">Contributing</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/api/CONTRIBUTING.html#what" class="sidebar-link">What?</a></li><li class="sidebar-sub-header"><a href="/api/CONTRIBUTING.html#rules" class="sidebar-link">Rules</a></li><li class="sidebar-sub-header"><a href="/api/CONTRIBUTING.html#releases" class="sidebar-link">Releases</a></li><li class="sidebar-sub-header"><a href="/api/CONTRIBUTING.html#changes-to-this-arrangement" class="sidebar-link">Changes to this arrangement</a></li><li class="sidebar-sub-header"><a href="/api/CONTRIBUTING.html#heritage" class="sidebar-link">Heritage</a></li></ul></li></ul> </aside> <main class="page"> <div class="content default"><h1 id="polkadot-api"><a href="#polkadot-api" aria-hidden="true" class="header-anchor">#</a> @polkadot/api</h1> <p>The Polkadot-JS API provides easy-to-use wrappers around JSONRPC calls that flow from an application to a node. It handles all the encoding and decoding or parameters, provides access to RPC functions and allows for the query of chain state and the submission of transactions.</p> <p>The API wrappers provide a standard interface for use -</p> <ul><li>A static <code>.create(&lt;optional ApiOptions&gt;)</code> that returns an API instance when connected, decorated and ready-to use. ApiOptions can include an optional WsProvider and optional custom type definitions <code>{ provider: &lt;Optional WsProvider&gt;, types: &lt;Optional RegistryTypes&gt; }</code>.</li> <li>The above is just a wrapper for <code>new Api(&lt;optional ApiOptions&gt;)</code>, exposing the <code>isReady</code> getter</li> <li><code>api.rpc.&lt;section&gt;.&lt;method&gt;</code> provides access to actual RPC calls, be it for queries, submission or retrieving chain information
<ul><li><a href="/api/METHODS_RPC.html">RPC (node interface)</a></li></ul></li> <li><code>api.query.&lt;section&gt;.&lt;method&gt;</code> provides access to chain state queries. These are dynamically populated based on what the runtime provides
<ul><li><a href="/api/METHODS_STORAGE.html">Storage chain state (runtime node interface)</a></li></ul></li> <li><code>api.tx.&lt;section&gt;.&lt;method&gt;</code> provides the ability to create a transaction, like chain state, this list is populated from a runtime query
<ul><li><a href="/api/METHODS_EXTRINSICS.html">Extrinsics (runtime node interface)</a></li></ul></li></ul> <h2 id="api-selection"><a href="#api-selection" aria-hidden="true" class="header-anchor">#</a> API Selection</h2> <p>There are two flavours of the API provided, one allowing a standard interface via JavaScript Promises and the second provides an Observable wrapper using <a href="https://github.com/ReactiveX/rxjs" target="_blank" rel="noopener noreferrer">RxJS<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>. Depending on your use-case and familiarity, you can choose either (or even both) for your application.</p> <ul><li><a href="/api/api/classes/_promise_api_.apipromise.html">ApiPromise</a> All interface calls returns Promises, including the static <code>.create(...)</code>. Additionally any subscription method uses <code>(value) =&gt; {}</code> callbacks, returning the value as the subscription is updated.</li> <li><a href="/api/api/classes/_rx_api_.apirx.html">ApiRx</a> All interface calls return RxJS Observables, including the static <code>.create(...)</code>. In the same fashion subscription-based methods return long-running Observables that update with the latest values.</li></ul> <h2 id="dynamic-by-default"><a href="#dynamic-by-default" aria-hidden="true" class="header-anchor">#</a> Dynamic by default</h2> <p>Substrate (upon which Polkadot is built) uses on-chain WASM runtimes, allowing for upgradability. Each runtime defining the actual chain extrinsics (submitted transactions and block intrinsics) as well as available entries in the chain state. Due to this, the API endpoints for queries and transactions are dynamically populated from the running chain.</p> <p>Due to this dynamic nature, this API departs from traditional APIs which only has fixed endpoints, driving use by what is available by the runtime. As a start, this generic nature has a learning curve, although the provided documentation, examples and linked documentation tries to make that experience as seamless as possible.</p> <h2 id="installation-import"><a href="#installation-import" aria-hidden="true" class="header-anchor">#</a> Installation &amp; import</h2> <p>Installation -</p> <div class="language- line-numbers-mode"><pre class="language-text"><code>npm install --save @polkadot/api
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br></div></div><p>Subscribing to blocks via Promise-based API -</p> <div class="language-javascript line-numbers-mode"><pre class="language-javascript"><code><span class="token keyword">import</span> <span class="token punctuation">{</span> ApiPromise <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'@polkadot/api'</span><span class="token punctuation">;</span>
<span class="token comment">// initialise via static create</span>
<span class="token keyword">const</span> api <span class="token operator">=</span> <span class="token keyword">await</span> ApiPromise<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// make a call to retrieve the current network head</span>
api<span class="token punctuation">.</span>rpc<span class="token punctuation">.</span>chain<span class="token punctuation">.</span><span class="token function">subscribeNewHead</span><span class="token punctuation">(</span><span class="token punctuation">(</span>header<span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token template-string"><span class="token string">`Chain is at #</span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span>header<span class="token punctuation">.</span>blockNumber<span class="token interpolation-punctuation punctuation">}</span></span><span class="token string">`</span></span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br></div></div><p>Subscribing to blocks via RxJS-based API -</p> <div class="language-javascript line-numbers-mode"><pre class="language-javascript"><code><span class="token keyword">import</span> <span class="token punctuation">{</span> ApiRx <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'@polkadot/api'</span><span class="token punctuation">;</span>
<span class="token comment">// initialise via static create</span>
<span class="token keyword">const</span> api <span class="token operator">=</span> <span class="token keyword">await</span> ApiRx<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">toPromise</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// make a call to retrieve the current network head</span>
api<span class="token punctuation">.</span>rpc<span class="token punctuation">.</span>chain<span class="token punctuation">.</span><span class="token function">subscribeNewHead</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">subscribe</span><span class="token punctuation">(</span><span class="token punctuation">(</span>header<span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token template-string"><span class="token string">`Chain is at #</span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span>header<span class="token punctuation">.</span>blockNumber<span class="token interpolation-punctuation punctuation">}</span></span><span class="token string">`</span></span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br></div></div><h2 id="registering-custom-types"><a href="#registering-custom-types" aria-hidden="true" class="header-anchor">#</a> Registering custom types</h2> <p>Additional types used by runtime modules can be added when a new instance of the API is created. This is necessary if the runtime modules use types which are not available in the base Substrate runtime.</p> <div class="language-javascript line-numbers-mode"><pre class="language-javascript"><code><span class="token keyword">import</span> <span class="token punctuation">{</span> ApiPromise <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'@polkadot/api'</span><span class="token punctuation">;</span>
<span class="token comment">// initialise via static create and register custom types</span>
<span class="token keyword">const</span> api <span class="token operator">=</span> <span class="token keyword">await</span> ApiPromise<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
types<span class="token punctuation">:</span> <span class="token punctuation">{</span>
CustomTypesExample<span class="token punctuation">:</span> <span class="token punctuation">{</span>
<span class="token string">&quot;id&quot;</span><span class="token punctuation">:</span> <span class="token string">&quot;u32&quot;</span><span class="token punctuation">,</span>
<span class="token string">&quot;data&quot;</span><span class="token punctuation">:</span> <span class="token string">&quot;Vec&lt;u8&gt;&quot;</span><span class="token punctuation">,</span>
<span class="token string">&quot;deposit&quot;</span><span class="token punctuation">:</span> <span class="token string">&quot;Balance&quot;</span><span class="token punctuation">,</span>
<span class="token string">&quot;owner&quot;</span><span class="token punctuation">:</span> <span class="token string">&quot;AccountId&quot;</span><span class="token punctuation">,</span>
<span class="token string">&quot;application_expiry&quot;</span><span class="token punctuation">:</span> <span class="token string">&quot;Moment&quot;</span><span class="token punctuation">,</span>
<span class="token string">&quot;whitelisted&quot;</span><span class="token punctuation">:</span> <span class="token string">&quot;bool&quot;</span><span class="token punctuation">,</span>
<span class="token string">&quot;challenge_id&quot;</span><span class="token punctuation">:</span> <span class="token string">&quot;u32&quot;</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br><span class="line-number">14</span><br><span class="line-number">15</span><br><span class="line-number">16</span><br></div></div><h2 id="users"><a href="#users" aria-hidden="true" class="header-anchor">#</a> Users</h2> <p>Some of the users of the API (let us know if you are missing from the list), include -</p> <ul><li><a href="https://github.com/polkadot-js/apps" target="_blank" rel="noopener noreferrer">Polkadot-JS UI<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> A user-interface that allows you to make transactions, query the network or participate in actions on the network such as referendums and staking</li> <li><a href="https://gitlab.com/Polkabot" target="_blank" rel="noopener noreferrer">Polkabot<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> Polkabot is a Matrix chatbot that keeps an eye on the Polkadot network. You can see Polkabot in action in <a href="https://matrix.to/#/#polkadot-network-status:matrix.org" target="_blank" rel="noopener noreferrer">https://matrix.to/#/#polkadot-network-status:matrix.org<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></li> <li><a href="https://polkawallet.io" target="_blank" rel="noopener noreferrer">Polkawallet.io<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> and <a href="https://github.com/polkawallet-io/polkawallet-RN/" target="_blank" rel="noopener noreferrer">Polkawallet (Github)<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> A mobile wallet for the Polkadot network to manage funds and make transactions, available on both Androind and iOS</li></ul> <h2 id="classes"><a href="#classes" aria-hidden="true" class="header-anchor">#</a> Classes</h2> <p><a href="/api/api/SUMMARY.html">Classes</a></p></div> <footer class="page-edit"><!----> <!----></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/api/METHODS_EVENTS.html" class="prev">
System events (defaults)
</a></span> <span class="next"><a href="/api/types/">
@polkadot/types
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/api/assets/js/app.ea488efd.js" defer></script><script src="/api/assets/js/2.16c7e4af.js" defer></script><script src="/api/assets/js/42.8407b7c4.js" defer></script>
</body>
</html>