- Previous:
- Up:
- Next: Getting Started
Introduction
Welcome to the Central Index, the global data exchange for local business information. We want this API to help you build amazing applications, and at the same time help us build the most accurate and trusted source of local data in the world.
How our data is organised
In the Central Index world a local business (your local dry cleaner, say, or a nearby coffee shop) is called an entity. And every entity has a large number of attributes, which we call objects. An entity will normally have at least four core objects...
- A name (e.g. "Gladys's Hair Salon")
- An address (e.g. "3 Meath Street, Dublin, Dublin 8" )
- A telephone number (e.g. "085 1313100")
- A business category (e.g. "Unisex Hairdresser")
... but it can have many more: website URLs, fax numbers, descriptions, email addresses, images, logos, videos, opening hours. We hope to keep adding more and more attributes to our entities as time goes by.
Each object can have multiple fields. For example a website object not only has the site URL, but also a website description paramenter and a display URL parameter, all of which you can use depending how you want to display information.
What you can do with our API
Our API allows you to:
- Perform national or local searches for a supplied search term
- Perform national or local searches for a supplied company name
- Perform searches for advertisers that match the supplied tags and location terms
- Retrieve individual businesses
- Enable your users to report incorrect data
- Enable your users to Add new entities to the Central Index
- Auto-suggest category and locations from our database of categories and locations
Other API calls are available for premium customers.
Our documentation will show you how to get an API key; how to do searches and retrieve entities; what sort of data points you can expect to find in the different objects and how to enage your community in adding entities and correcting data in the Central Index.
We welcome your feedback, email us on developers@centralindex.com
- Previous:
- Up:
- Next: Getting Started
Docs Navigation
- Introduction
- Getting Started
- Using IODocs
- Responses
- Creating a sample request
- Sample Libraries
- Central Index API
- What data do we store in an entity?
- GET /v1/advertiser/updated
- GET /v1/autocomplete/category
- GET /v1/autocomplete/keyword
- GET /v1/autocomplete/location
- GET /v1/entity
- GET /v1/entity/advertisers
- GET /v1/entity/advertisers/inventorycheck
- GET /v1/entity/by_supplier_id
- GET /v1/entity/search/keyword/bynearest
- GET /v1/entity/search/what
- GET /v1/entity/search/what/bylocation
- GET /v1/entity/search/what/byboundingbox
- GET /v1/entity/search/what/bynearest
- GET /v1/entity/search/who
- GET /v1/entity/search/who/bylocation
- GET /v1/entity/search/who/byboundingbox
- GET /v1/entity/search/who/bynearest
- GET /v1/location
- GET /v1/location/context
- GET /v1/lookup/category
- GET /v1/match/byphone
- GET /v1/stats/entity/by_date
- GET /v1/syndication_log/by_entity_id
- GET /v1/token/add
- GET /v1/token/report
- GET /v1/token/claim
- GET /v1/token/message
- GET /v1/tools/docs
- GET /v1/user/by_email
- PUT /v1/business
- PUT /v1/business/json
- PUT /v1/entityserve
- POST /v1/entity/advertiser/cancel
- POST /v1/entity/advertiser/create
- POST /v1/entity/advertiser/renew
- POST /v1/entity/advertiser/upsell
- POST /v1/entity/category
- POST /v1/entity/claim
- POST /entity/claim/cancel
- POST /v1/entity/claim/reseller
- POST /v1/entity/description
- POST /v1/entity/document
- POST /v1/entity/email
- POST /v1/entity/fax
- POST /v1/entity/featured_message
- POST /v1/entity/geopoint
- POST /v1/entity/image
- POST /v1/entity/image/by_url
- POST /v1/entity/list
- POST /v1/entity/logo
- POST /v1/entity/logo/by_url
- POST /v1/entity/name
- POST /v1/entity/opening_times
- POST /v1/entity/payment_type
- POST /v1/entity/phone
- POST /v1/entity/postal_address
- POST /v1/entity/socialmedia
- POST /v1/entity/special_offer
- POST /v1/entity/tag
- POST /v1/entity/testimonial
- POST /v1/entity/video/youtube
- POST /v1/entity/website
- POST /v1/syndication/cancel
- POST /v1/syndication/create
- POST /v1/signal
- POST /v1/user
- DELETE /v1/entity/category
- DELETE /v1/entity/description
- DELETE /v1/entity/image
- DELETE /v1/entity/phone
- DELETE /v1/entity/logo
- DELETE /v1/entity/website
- syndication api