CINXE.COM

:

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content=""> <meta name="author" content=""> <link rel="icon" href="../../favicon.ico"> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script> <script src='/js/jquery.wiggle.min.js' type='text/javascript'></script> <script src="/js/explorer.js" type="text/javascript"></script> <link href="/css/xcode.css" type="text/css" media="screen" rel="stylesheet"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous"> <link href="/css/style.css" rel="stylesheet"> <link href="/css/govstrap.css" rel="stylesheet"> <link href="/css/govstrap_extra.css" rel="stylesheet"> <link href="/css/developer.css" rel="stylesheet"> <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,600" rel="stylesheet"> <link href='https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css' rel='stylesheet' type='text/css'> <!--[if lt IE 9]> <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> <![endif]--> <script src='/js/highlight.pack.js' type='text/javascript'></script> <script>hljs.initHighlightingOnLoad();</script> <title>: </title> </head> <body > <nav class="navbar navbar-fixed-top shadow"> <div class="container-fluid"> <div class="row"> <div class="1 col-lg-1 hidden-xs hidden-sm hidden-md"></div> <div class="col-xs-12 col-sm-12 col-md-12 col-lg-10"> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="/">Companies House</a> </div> <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> <ul class="nav navbar-nav navbar-right"> <li> <a href="/">All APIs</a> </li> </ul> </div> </div> <div class="col-lg-1 hidden-xs hidden-sm hidden-md"></div> </div> </div> </nav> <div class="container-fluid"> <div class="row"> <div class="hidden-md col-lg-1 hidden-xs hidden-sm"></div> <div class="col-xs-12 col-sm-12 col-md-12 col-lg-10 main-body"> <div class="body-header body-header-content"> <ul id="SIN" class="nav navbar-nav navbar-right userbar deactivate"> <li> <span class="user_info" id="email"></span>: </li> <li><a href="/developer/applications">Applications</a></li> <li> <a href="/developer/signout">Sign&nbsp;out</a> </li> </ul> <ul id="SOUT" class="nav navbar-nav navbar-right userbar deactivate"> <li><a href="/developer/signin">Sign&nbsp;in</a></li> </ul> <ul id="ERROR" class="nav navbar-nav navbar-right userbar deactivate"> <li id="placeholder"></li> </ul> </div> <div class="row"> <div class="col-xs-12 col-sm-3 col-md-3 col-lg-3"> <script> $(document).ready(function(){ $('.items').hide(); var $pagename=decodeURI( window.location.pathname ); var $parent=$('ul[id="navigation"]'); var $element=$parent.find('a[href$="'+$pagename+'"]'); if( $element.length == 0 ) { $pagename = sessionStorage.lastpage; $element=$parent.find('a[href$="'+$pagename+'"]'); } sessionStorage.lastpage = $pagename; var api_id = $element.data('outer'); var toggler = $("#toggle"+api_id); var outerul = $("#ul"+api_id); outerul.addClass('in'); toggler.addClass('open'); toggler.removeClass('collapsed'); $element.addClass('nav-selected'); $parent.removeClass('hide'); }); </script> <div class="side-nav affix"> <ul class="nav nav-sidebar hide" id="navigation"> <li> <a href="/guides/index">Companies House API</a> </li> <li> <a href="/guides/gettingStarted">Getting started</a> </li> <li> <a href="/guides/quickStart">Quick start</a> </li> <li> <a href="/guides/introduction">Introduction</a> </li> <li> <a href="/guides/authorisation">Authorisation</a> </li> <li> <a href="/guides/developerGuidelines">Developer guidelines</a> </li> <li> <a href="/guides/rateLimiting">Rate limiting</a> </li> <li> <a href="/guides/versioning">API versioning</a> </li> </ul> </div> </div> <div class="col-xs-12 col-sm-9 col-md-9 col-lg-9 main"> <h1 class="page-header"><a name="getting-started-with-the-companies-house-api" class="anchor" href="#getting-started-with-the-companies-house-api" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>Getting started with the Companies House API</h1> <p>The Companies House API lets you retrieve information about limited companies (and other companies that fall within the Companies Act 2006). The data returned is live and real-time, and is simple to use and understand.</p> <h2 class="sub-header"><a name="quick-start" class="anchor" href="#quick-start" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> Quick start</h2> <p>If you are already familiar with JSON RESTful APIs, then you can jump straight in with the <a href="/guides/quickStart" rel="nofollow">quick start guide</a>.</p> <p>Otherwise, read on for a quick tour of the essentials.</p> <h2 class="sub-header"><a name="first-steps" class="anchor" href="#first-steps" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> First steps</h2> <ul> <li><a href="#getting-started-with-the-companies-house-api" rel="nofollow">Getting started with the Companies House API</a> <ul> <li><a href="#quick-start" rel="nofollow">Quick start</a></li> <li><a href="#first-steps" rel="nofollow">First steps</a></li> <li><a href="#set-up-a-companies-house-account" rel="nofollow">Set up a Companies House account</a></li> <li><a href="#overview" rel="nofollow">Overview</a></li> <li><a href="#rest-web-services" rel="nofollow">REST web services</a></li> <li><a href="#the-json-data-format" rel="nofollow">The JSON data format</a></li> <li><a href="#authentication" rel="nofollow">Authentication</a></li> <li><a href="#developer-guidelines" rel="nofollow">Developer guidelines</a></li> <li><a href="#api-rate-limits" rel="nofollow">API rate limits</a></li> <li><a href="#enumerated-types" rel="nofollow">Enumerated types</a></li> </ul></li> </ul> <h3 class="sub-sub-header"><a name="set-up-a-companies-house-account" class="anchor" href="#set-up-a-companies-house-account" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> Set up a Companies House account</h3> <p>To be able to explore and perform tests with the Companies House API, you need to register a <a href="https://developer.company-information.service.gov.uk/signin" rel="nofollow">user account</a> with Companies House.</p> <h3 class="sub-sub-header"><a name="overview" class="anchor" href="#overview" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> Overview</h3> <p>The Companies House API <a href="/guides/companiesHouseAPI" rel="nofollow">overview</a> describes the basic operation of the API.</p> <h3 class="sub-sub-header"><a name="rest-web-services" class="anchor" href="#rest-web-services" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> REST web services</h3> <p>REST, or <a href="http://en.wikipedia.org/wiki/Representational_state_transfer" rel="nofollow">Representational State Transfer</a>, is an architectural software style in which standard HTTP requests are used to provide a simple and consistent approach to requesting and modifying data.</p> <p>In a RESTful style of API, data resources are allocated unique URLs and manipulated through standard HTTP verbs such as <code>GET</code> to request a resource, <code>POST</code> to create a resource, <code>PUT</code> to change a resource, and <code>DELETE</code> to remove a resource.</p> <p>Further details on how the Companies House REST API works can be found in the <a href="/guides/introduction" rel="nofollow">introduction</a> page.</p> <h3 class="sub-sub-header"><a name="the-json-data-format" class="anchor" href="#the-json-data-format" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> The JSON data format</h3> <p>JSON, or <a href="https://en.wikipedia.org/wiki/JSON" rel="nofollow">JavaScript Object Notation</a>, is an open, standard format for storing and exchanging data. It is easier to use than XML, is more compact, and can be used as a data format by any programming language. This makes it ideal for HTTP-based API services.</p> <p>Further information can be found at <a href="http://www.json.org" rel="nofollow">json.org</a>.</p> <h3 class="sub-sub-header"><a name="authentication" class="anchor" href="#authentication" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> Authentication</h3> <p>Access to all API services requires authentication. The <a href="/guides/authorisation" rel="nofollow">Authorisation</a> page describes the authorisation mechanism used by the Companies House API, and how to register your application.</p> <h3 class="sub-sub-header"><a name="developer-guidelines" class="anchor" href="#developer-guidelines" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> Developer guidelines</h3> <p>There are some simple developer <a href="/guides/developerGuidelines" rel="nofollow">guidelines</a> you can follow to help you achieve success with the Companies House API.</p> <h3 class="sub-sub-header"><a name="api-rate-limits" class="anchor" href="#api-rate-limits" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> API rate limits</h3> <p>The Companies House API is subject to <a href="/guides/rateLimiting" rel="nofollow">rate limiting</a> to protect the quality of service for all users.</p> <h3 class="sub-sub-header"><a name="enumerated-types" class="anchor" href="#enumerated-types" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a> Enumerated types</h3> <p>A majority of the resources returned by the Companies House API contain members that reference <a href="https://en.wikipedia.org/wiki/Enumerated_type" rel="nofollow">enumuration types</a>. This helps make the resources self-documenting, and allow clients to interpret the meaning of a resource member without needing to otherwise parse a text description. Enumeration types are frequently used to supplement or replace a text description, which allows clients to display their own version of a description, more fitting their use case, or provide descriptions in multiple languages.</p> <p>The collection of enumuration types used by Companies House are available on <a href="https://github.com/companieshouse/api-enumerations" rel="nofollow">GitHub</a>. These files provide a mapping between enumuration type and text description, and are divided into sets or classes. Each API resource member will define which class of enumuration is being returned.</p> <p>A planned enhancement to the enumuration scheme is the provision of API endpoints that will return the enumuration class catalogue. This avoids having enumurations hard-coded within a client, and by periodically checking for change through ETags, avoids clients having to download the full catalogue unnecessarily.</p> </div> </div> </div> <div class="col-lg-1 hidden-xs hidden-sm hidden-md"></div> </div> </div> <div id="footer" class="footer"> <div class="container-fluid"> <div class="row"> <div class="col-lg-1 hidden-xs hidden-sm hidden-md"></div> <div class="col-xs-12 col-sm-12 col-md-12 col-lg-10"> <ul class="nav navbar-nav"> <li><a href="http://www.companieshouse.gov.uk/legal/termsAndConditions.shtml">Policies</a></li> <li><a href="https://find-and-update.company-information.service.gov.uk/help/cookies">Cookies</a></li> <li><a href="http://forum.aws.chdev.org">Forum</a></li> <li><a href="https://find-and-update.company-information.service.gov.uk/help/contact-us">Contact us</a></li> </ul> </div> <div class="col-lg-1 hidden-xs hidden-sm hidden-md"></div> </div> </div> </div> <script src="/js/userbar.js"></script> <script> $(document).ready(function(){ apiExplorer.setBeforeSendCallback( function( request ) { var apiKey = apiExplorer.readApiKey(); var accessToken = apiExplorer.readAccessToken(); var basicAuth = apiExplorer.getBasicAuthentication(); if( accessToken != "" ) { request.headers = {Authorization: "Bearer "+accessToken}; } else if( apiKey != "" ) { request.params = {key: apiKey}; } else if( basicAuth != "" ) { request.headers = {Authorization: "Basic "+basicAuth}; } }); }); </script> </body> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js" integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script> </html>

Pages: 1 2 3 4 5 6 7 8 9 10