CharityData (Beta)

Using the API

 This service may not be maintained

The API service and data on this site may not be maintained in a timely manner. You may prefer to make use of CharityBase rather than this API.

The entire database is available via a RESTFUL API, which will return results in the JSON format. The service works exactly the same way as the HTML service, and you can simply amend the URL from html to json to get a JSON response.

To make a search query, make a get call to https://olib.uk/charity/json/search using the parameters below.

To get details of a specifc charity, make a get call to https://olib.uk/charity/json/charity/n, where n is the charity registration number.

Please note the following:

  • Parameters fields can be sent in camelCase, but will be automatically turned into lower case
  • The search service will only return a maximum of 250 entries against a query, and a maximum of 50 entries per page. The default is 20.
  • You can not search on email addresses, although these will be returned in the charity details
  • Similarly, you can not currently search on historical annual returns, annual reports or "Part B" information, although these will be returned in the charity details
  • The service only includes active charities, and does not hold information on charities that have been removed from the register.
  • You must include the licence information contained within the boilerplate attribute in both the search results and charity details pages. If you use social media data and/or data about MPs, you must show the respective credit contained in the boilerplate.
  • The service is provided as is; please report any problems with using the service.

For more extensive information on the data, please see the Charity Commission data definition webpage. Guidance on Annual Returns and Annual Accounts is also available.

Types of parameters

Primary Parameters

registrationNumber

  • Description: The charity registration number
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.
  • Notes: The charity registration number will always be returned in a search query
  • Example values:
    • 205846
    • 1089464

subRegistrationNumber

  • Description: The sub-charity registration number
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.
  • Notes: This is the number of a charity that is affiliated to a larger charity. Each sub charity is given a number starting at 1, which will be used with the main charity registration number.

name

  • Description: The names the charity is known as
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: This is the default name search, and includes any alternative name the charity will use.
  • Example values:
    • National Trust
    • St John Ambulance
    • Red*
    • *Royal*

formalName

  • Description: The formal/legal name the charity is known as
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: This is the legal name of the charity. It will be always be returned in a search query. If you are building a search query based on names, you should use the names parameter unless you are specifically wanting to search only the formal name.
  • Example values:
    • THE NATIONAL TRUST FOR PLACES OF HISTORIC INTEREST OR NATURAL BEAUTY
    • THE PRIORY OF ENGLAND AND THE ISLANDS OF THE MOST VENERABLE ORDER OF THE HOSPITAL OF ST. JOHN OF JERUSALEM

numOfSubCharities

  • Description: Number of sub-charities connected with the charity
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.
  • Example values:
    • >10

numOfTrustees

  • Description: Number of trustees involved in the charity
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.
  • Example values:
    • >10

dateOfRegistration

  • Description: The date the charity was registered with the Charity Commission
  • What will be accepted: Date in YYYY-MM-DD format. Add <,>,! at start for before, after or not equal, otherwise will be an exact match.
  • Notes: Date of registration, which is not the same as the date the charity started.
  • Example values:
    • 2016-03-15
    • >1977-01-21

governingDocument

  • Description: Details of the governing documents
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.

areaOfBusiness

  • Description: Text description of the area the charity conducts its business in
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: This field seems to be superceded by the areasofoperation lookup, which is more useful for searching.

object

  • Description: Details of the object of the charity
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: This the legal wording of the object of the charity. Not necessarily the most useful description of what the charity does.

companyNumber

  • Description: The company number for the charity
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.
  • Notes: Many charities are also registered as companies. This has the number. It can be checked against the database at Companies House.

website

  • Description: The website address
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: If it validates as URL, then will return a validated field alongside the original, which will add the http:// if that has not been added.

income

  • Description: The last reported income for the charity
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.
  • Example values:
    • 1012345
    • 7584
    • 10m
    • 50t

incomeDate

  • Description: The date of the last reported income for the charity
  • What will be accepted: Date in YYYY-MM-DD format. Add <,>,! at start for before, after or not equal, otherwise will be an exact match.
  • Example values:
    • >2016-07-01
    • !2017-01-31

classes

  • Description: Lookup values associated with the type of work the charity does
  • What will be accepted: Can be searched by lookup id. Multiple entries accepted, divided by a comma. These will return charities that have *any* of the values, not charities that meet *all* the values
  • Example values:
    • 301
    • 302
    • 301,302
  • URL: /charity/json/lookups/classes/

areasOfOperation

  • Description: Lookup values associated with the where the charity undertakes its activity
  • What will be accepted: Can be searched by lookup id. Multiple entries accepted, divided by a comma. These will return charities that have *any* of the values, not charities that meet *all* the values
  • Notes: There are some inconsistencies in the categorisation, so thigs like Greater London appear in two different places.
  • Example values:
    • A-1
    • B-172
    • A-1,B-172
  • URL: /charity/json/lookups/areasofoperation/

aimsActivities

  • Description: Details of aims and activities of the charity. This field is not included in the dataset released by the Charity Commission, but is included on the charity's listing on the Charity Commission website.
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: This field is sourced by 'scraping' the data from the page. If this field is blank, you call the following URL, replacing n with the charity reg no. Will return the text and add to the database.
  • URL: /charity/scrape/aims_activities.php?n

Address Parameters

contact

  • Description: A contact name, or details of the contact
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: Contains either a name or sometimes a title / name of charity as the person to contact about the charity. Often a company secretary type role, rather than someone who is involved in delivering the charity's mission

address

  • Description: A single text field containing the charity's address, lines divided by commas
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: Merges the address line fields into a single text field.

postcode

  • Description: The postcode given for the charity.
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: If it is a valid postcode, will return an array with details of longitude and latitude and local government information. Please note that the Charity Commission does no verification of the postcode, so we try and verify the postcde

phone

  • Description: The phone number given for the charity.
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: If it is a valid UK phone number, will return the number in a variety of different formats. The Charity Commission does not verify the phone numbers, so many contain information other than the actual phone number.

Financial Parameters

fystart

  • Description: The date of the start of the last financial year that has been report by the charity.
  • What will be accepted: Date in YYYY-MM-DD format. Add <,>,! at start for before, after or not equal, otherwise will be an exact match.
  • Notes: Should generally be 12 months earlier than incomeDate, unless the charity is not reporting a full year.
  • Example values:
    • >2016-07-01
    • !2017-01-31

fyend

  • Description: The date of the end of the last financial year that has been reported by the charity.
  • What will be accepted: Date in YYYY-MM-DD format. Add <,>,! at start for before, after or not equal, otherwise will be an exact match.
  • Notes: Should be the same as the incomeDate.
  • Example values:
    • >2016-07-01
    • !2017-01-31

fIncome

  • Description: Annual income
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

fExpenditure

  • Description: The last reported expenditure for the charity
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.
  • Example values:
    • 1012345
    • 7584

submitDate

  • Description: Date Annual Accounts Submitted
  • What will be accepted: Date in YYYY-MM-DD format. Add <,>,! at start for before, after or not equal, otherwise will be an exact match.

arno

  • Description: Annual Report year
  • What will be accepted: Date in YYYY-MM-DD format. Add <,>,! at start for before, after or not equal, otherwise will be an exact match.

daysOverdue

  • Description: Number of days the annual accounts is overdue
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

Locality Parameters

localAuthority

  • Description: Lookup values associated with the local authority the charity's head office is based in.
  • What will be accepted: Can be searched by lookup id. Multiple entries accepted, divided by a comma. These will return charities that have *any* of the values, not charities that meet *all* the values
  • Notes: There are the primary local authority that the head office is based in, determined by the postcode. Excludes English county councils. Will returned the full name, rather than the code. Codes are based on http://www.openregister.org/ codes.
  • Example values:
    • DUD
    • PEN
    • OXO
    • NWL
  • URL: /charity/json/lookups/localauthorities/

countyCouncil

  • Description: Lookup values associated with the local county council the charity's head office is based in.
  • What will be accepted: Can be searched by lookup id. Multiple entries accepted, divided by a comma. These will return charities that have *any* of the values, not charities that meet *all* the values
  • Notes: Where there is a two-tier system of local authorities, this will search for the county council. Will return the full name rather than the code. Codes are based on http://www.openregister.org/ codes.
  • Example values:
    • OXF
    • DOR
    • LAN
  • URL: /charity/json/lookups/countycouncils/

country

  • Description: Lookup values associated with the UK nation where the charity's head office is based.
  • What will be accepted: Can be searched by lookup id. Multiple entries accepted, divided by a comma. These will return charities that have *any* of the values, not charities that meet *all* the values
  • Notes: Based on postcode. Does no return value for address outside of the UK.
  • Example values:
    • ENG
    • SCO
    • WAL
    • NI
  • URL: /charity/json/lookups/countries/

constituency

  • Description: Parliamentary constituency where the charity's head office is based.
  • What will be accepted: Can be searched by lookup id. Multiple entries accepted, divided by a comma. These will return charities that have *any* of the values, not charities that meet *all* the values
  • Notes: Based on postcode. Uses data and codes used on theyworkforyou.com
  • Example values:
    • 41371
    • 41372
  • URL: /charity/json/lookups/constituencies/

parish

  • Description: Where applicable, the name of the parish the charity's head office is based.
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: Based on postcode. Not all postcodes have parishes. See postcodes.io documentation for futher details.

ward

  • Description: The local ward the charity's head office is based.
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: Based on postcode. See postcodes.io documentation for futher details.

lsoa

  • Description: The lower layer SOA code the charity's head office is based.
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: Based on postcode. See postcodes.io documentation for futher details.

metroArea

  • Description: Where applicable the metropolitan area the charity's head office is based.
  • What will be accepted: Can be searched by lookup id. Multiple entries accepted, divided by a comma. These will return charities that have *any* of the values, not charities that meet *all* the values
  • Notes: Based on postcode. Only the defined English metropolitan ares are included.
  • Example values:
    • LDN
    • GMCR
    • WMIDS
  • URL: /charity/json/lookups/metroareas/

Trustee Parameters

maleTrustees

  • Description: Number of male trustees
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

femaleTrustees

  • Description: Number of female trustees
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

unknownTrustees

  • Description: The number of trustees where the gender is unknown
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

organisationTrustees

  • Description: Number of trustees which are identified as an organisation
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

percentageFemale

  • Description: The percentage of trustees who are female
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

trusteeFirstname

  • Description: Firstname of trustee
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.

trusteeSurname

  • Description: Surname of trustee
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.

Part B Parameters

Part B details are required for charities with an income of over £100,000

artype

  • Description: annual return mailing cycle co
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.

bfystart

  • Description: Charity's financial year start date
  • What will be accepted: Date in YYYY-MM-DD format. Add <,>,! at start for before, after or not equal, otherwise will be an exact match.

bfyend

  • Description: Charity's financial year end date
  • What will be accepted: Date in YYYY-MM-DD format. Add <,>,! at start for before, after or not equal, otherwise will be an exact match.

incLeg

  • Description: Legacies
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

incEnd

  • Description: Endowments
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

incVol

  • Description: Voluntary Income
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

incFr

  • Description: Activities generating funds
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

incChar

  • Description: Charitable activities
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

incInvest

  • Description: Investment income
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

incOther

  • Description: Other Income
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

incTotal

  • Description: Total Incoming resources
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

investGain

  • Description: Gains/loss on investments
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

assetGain

  • Description: Revaluations of fixed assets
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

pensionGain

  • Description: Gains/loss on Pension Fund
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

expVol

  • Description: Voluntary income costs
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

expTrade

  • Description: Fundraising Trading costs
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

expInvest

  • Description: Investment Management costs
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

expGrant

  • Description: Grants to institutions
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

expCharble

  • Description: Charitable Activities costs
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

expGov

  • Description: Governance costs
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

expOther

  • Description: Other resources expended
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

expTotal

  • Description: Total Resources expended
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

expSupport

  • Description: Support costs
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

expDep

  • Description: Depreciation
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

reserves

  • Description: Reserves
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

assetOpen

  • Description: Total fixed assets (at start of year)
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

assetClose

  • Description: Total fixed assets
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

fixedAssets

  • Description: Fixed Investments Assets
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

openAssets

  • Description: Fixed Investments Assets (start of year)
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

investAssets

  • Description: Current Investment Assets
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

cashAssets

  • Description: Cash
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

currentAssets

  • Description: Total Current Assets
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

credit1

  • Description: Creditors - within one year
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

creditLong

  • Description: Creditors - Long Term/Provision
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

pensionAssets

  • Description: Pension Assets/Liabilities
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

totalAssets

  • Description: Total Net Assets/Liabilities
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

fundsEnd

  • Description: Endowment funds
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

fundsRestrict

  • Description: Restricted funds
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

fundsUnrestrict

  • Description: Unrestricted funds
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

fundsTotal

  • Description: Total funds
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

employees

  • Description: Employees
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

volunteers

  • Description: Volunteers
  • What will be accepted: Whole numbers only. Add <,>,! at start for less than, greater than or not equal, otherwise will be an exact match. Add m or t to end to indicate million or thousand.

consAcc

  • Description: Consolidated accounts (True/False)
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.

charityAcc

  • Description: Charity only accounts (True/False)
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.

Geolocation parameters

These parameters are specifically for geolocation searches

gpostcode

  • Description: Enter a valid postcode and will return nearest charities to location of postcode
  • Notes: Requires a valid postcode. Results will be returned in order of proximity
  • Example values:
    • B1 1RD
    • LS11 0AE

glatlng

  • Description: Enter the latitude and longitude comma seperated to return nearest charities
  • Example values:
    • 54.9141,1.5895

Social media parameters

smTwitter

  • Description: Charity Twitter handle
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: This data comes from OpenCharities.org and should be appropriately acknowledged.

smFacebook

  • Description: Charity Facebook page
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: This data comes from OpenCharities.org and should be appropriately acknowledged.

smYouTubeChannel

  • Description: Charity YouTube channel
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: This data comes from OpenCharities.org and should be appropriately acknowledged.

smYouTubeVideo

  • Description: Charity YouTube video
  • What will be accepted: Will accept alphanumeric characters. Add * at start/end if you do not want it to be an exact match.
  • Notes: This data comes from OpenCharities.org and should be appropriately acknowledged.

Meta parameters

These parameters are affect how the search results are presented, rather than what is searched for. Meta parameters are prefixed with an underscore (eg _view.

_view

  • Description: By default a search result will return the charity regno, the charity formalName and any fields used to filter (excluding lookup fields). If you want additional fields to be returned list them here by comma seperation.
  • Notes: This won't work for fields which have multiple entries associated with a charity, eg trustees.
  • Example values:
    • dateOfRegistration,income

_sort

  • Description: By default a search result will return results ordered by their formalName (0-9, A-Z). If you want to order in a different way, list them here. Putting a ! before a field reverses the search (eg !income orders highest to lowest).
  • Notes: If you are using a geoLocation search, it will prioritise ordering by proximity, regardless of what is entered in this field. It is possible to have multiple criteria, although the priorisation is not guaranteed (eg income, !dateofRegistration may order reverse dateOfRegistration and then income). Because of the way the database query is limited, if you order by a parameter that is not filtered, you will get the first 250 filtered entries ordered, which may not return the same result as if you ordered on the entire database.
  • Example values:
    • !income
    • dateOfRegistration

_resultsperpage

  • Description: Number of results per page
  • Notes: Minimum is 1, maximum is 50. Default is 20.
  • Example values:
    • 5
    • 10
    • 50

_pagenumber

  • Description: Results page number
  • Notes: Default will be 1. If page number x results per page is greater than results returned then will return the last page of results
  • Example values:
    • 5
    • 12

_iscount

  • Description: If equals 1 will return count only
  • Notes: The count is returned on every search results page, this allows you just to get the count.
  • Example values:
    • 1

_includesubs

  • Description: If equals 1 will include sub charities in results
  • Notes: This is still experimentation and may not work entirely as desired.
  • Example values:
    • 1

Search result fields

These are entries in the search results page that do not directly relate to a query parameter, but instead are returned in the search results.

distance

  • Description: Returns the distance from the search criteria to the charity location in kilometres.
  • Notes: To get miles, multiply the result by 0.621371

_totalresults

  • Description: Will return the total number of results that match the criteria in the database, even if only 250 results are displayed.
  • Notes: Doesn't appear on proximity searches. Result generally reflects total number of charities rather than results (eg if multiple trustees for same charity match criteria, will be counted once)

latLng

  • Description: If a postcode (or latLng) is entered, will return the latLng used to generate the query.