Understanding the HTTP API#
The package functionality reflects the current version (V0.1) of the Financial Services Register API. The API is documented but access requires registration.
The base URL for all API requests is:
https://register.fca.org.uk/services/V0.1
Resources and Endpoints#
There are three main categories of resource about which information can be requested from the register via API endpoints:
firms - authorised and/or regulated firms (either current or past) involved with the provision of regulated products and/or services. Firms in the register have unique firm reference numbers (FRN) and their endpoints usually take these as one of the parameters. They are described in more detail here.
individuals - individuals associated with the type of firms described above, either current or past. Individuals in the register have unique individual reference numbers (IRN) and their endpoints usually take these as one of the parameters. They are described in more detail here.
funds - investment funds or collective investment schemes (CIS),including subfunds of funds. Funds in the register have unique product reference numbers (PRN) and their endpoints usually take these as one of the parameters. They are described in more detail here.
There are also search endpoints that allow a search for (a) any of these resources by a name substring and a corresponding type specification (firm, individual, or fund), or (b) regulated markets. These are described in more detail here.
Request Headers#
For developers and end users the API, and this Python client library, is read-only - all requests must use GET, and include headers containing the API username and key:
ACCEPT: application/json
X-AUTH-EMAIL: <signup email / API username>
X-AUTH-KEY: <API key>
Rate Limiting#
According to the API documentation rate limiting is applied to set a maximum of 50 requests per 10 seconds per user, and breaches lead to (HTTP 429) errors and requests being blocked for 1 minute.
Warning
Please use the API and this library responsibly, and do not make excessive requests or use it in an otherwise inappropriate way.
Firm Requests#
Firms in the Register are identified by unique firm reference numbers (FRN). The following table summarises firm-specific API endpoints. For further details consult the API documentation.
API Endpoint |
Request Method |
Resource Parameters |
|---|---|---|
|
GET |
FRN (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str), Country (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str) |
|
GET |
FRN (str), Requirement Reference (str) |
Note
The abbreviations “CF” and “AR” refer to “controlled functions” and “appointed representatives” respectively.
For details and examples on calling these endpoints via this library see this.
Individual Requests#
Individuals associated with firms in the Register are identified by unique individual reference numbers (IRN). The following table summarises individual-specific API endpoints.
API Endpoint |
Request Method |
Resource Parameters |
|---|---|---|
|
GET |
IRN (str) |
|
GET |
IRN (str) |
|
GET |
IRN (str) |
Note
The abbreviation “CF” refers to “controlled functions”.
For how to call these endpoints see this.
Fund Requests#
Funds, also referred to as collective investment schemes (CIS) in the Register, are identified by unique product reference numbers (PRN). The following table summarises fund-specific API endpoints.
API Endpoint |
Request Method |
Resource Parameters |
|---|---|---|
|
GET |
PRN (str) |
|
GET |
PRN (str) |
|
GET |
PRN (str) |
For details and examples of calling these endpoints via this library see this.
Common Search Requests#
The common search API endpoint is a parameterised search endpoint which is summarised below.
API Endpoint |
Request Method |
Search Parameters |
|---|---|---|
|
GET |
|
Requests should be of the form:
GET https://register.fca.org.uk/services/V0.1/Search?q=resource_name&type=resource_type HTTP/1.1
For example, here are a few valid common search requests.
Common search for Barclays Bank Plc (FRN #122702):
GET https://register.fca.org.uk/services/V0.1/Search?q=Barclays+Bank+plc&type=firm HTTP/1.1
Common search for Hastings Insurance Services Limited (FRN #311492)
GET https://register.fca.org.uk/services/V0.1/Search?q=hastings+insurance+services&type=firm HTTP/1.1
Common search for all Natwest-related firms:
GET https://register.fca.org.uk/services/V0.1/Search?q=Natwest&type=firm HTTP/1.1
Common search for a specific individual, Mark Carney (IRN #MXC29012):
GET https://register.fca.org.uk/services/V0.1/Search?q=mark+carney&type=individual HTTP/1.1
Common search for a generic individual name “John Smith”, with multiple results:
GET https://register.fca.org.uk/services/V0.1/Search?q=John+Smith&type=individual HTTP/1.1
Common search for a specific fund, Jupiter Asia Pacific Income (PRN #635641):
GET https://register.fca.org.uk/services/V0.1/Search?q=jupiter+asia+pacific+income&type=fund HTTP/1.1
Common search for a specific fund, abrdn Multi-Asset Fund (PRN #637980):
GET https://register.fca.org.uk/services/V0.1/Search?q=abrdn+multi-asset+fund&type=fund HTTP/1.1
One particular type of common search-based endpoint that the API provides separately is for regulated markets. These are special markets which are regulated by UK and/or EU/EEA financial legislation. API requests for regulated markets should look as below:
GET https://register.fca.org.uk/services/V0.1/CommonSearch?q=RM HTTP/1.1
For details and examples on calling these endpoint via this library see this.