I/O Docs: API Documentation

• Production API

  • List Methods
  • Expand Methods

  • GET Getting an entity by id /v1/entity

    Allows a whole entity to be pulled from the datastore by its unique id

    Parameter	Value	Type	Description
    entity_id		string	The unique entity ID

  • GET Entity What/Where Search by Location /v1/entity/search/what/bylocation

    Search for matching entities

    Parameter	Value	Type	Description
    what		string	What to get results for. E.g. Plumber
    where		string	The location to get results for. E.g. Dublin
    per_page		string	Number of results returned per page
    page		string	Which page number to retrieve
    country		string	Which country to return results for. An ISO compatible country code, E.g. ie
    language		string	An ISO compatible language code, E.g. en
    latitude		string	The decimal latitude of the search context (optional)
    longitude		string	The decimal longitude of the search context (optional)

  • GET Entity What/Where Search by Bounding Box /v1/entity/search/what/byboundingbox

    Search for matching entities

    Parameter	Value	Type	Description
    what		string	What to get results for. E.g. Plumber
    latitude_1		string	Latitude of first point in bounding box
    longitude_1		string	Longitude of first point in bounding box
    latitude_2		string	Latitude of second point in bounding box
    longitude_2		string	Longitude of second point in bounding box
    per_page		string
    page		string
    country		string	A valid ISO 3166 country code
    language		string

  • GET Entity What Search /v1/entity/search/what

    Search for matching entities

    Parameter	Value	Type	Description
    what		string	What to get results for. E.g. Plumber
    per_page		string	Number of results returned per page
    page		string	The page number to retrieve
    country		string	Which country to return results for. An ISO compatible country code, E.g. ie
    language		string	An ISO compatible language code, E.g. en

  • GET Entity Who/Where Search by Bounding Box /v1/entity/search/who/byboundingbox

    Search for matching entities

    Parameter	Value	Type	Description
    who		string
    latitude_1		string
    longitude_1		string
    latitude_2		string
    longitude_2		string
    per_page		string
    page		string
    country		string

  • GET Entity Who/Where Search by Location /v1/entity/search/who/bylocation

    Search for matching entities

    Parameter	Value	Type	Description
    who		string	Company Name
    where		string	The location to get results for. E.g. Dublin
    per_page		string	Number of results returned per page
    page		string	Which page number to retrieve
    country		string	Which country to return results for. An ISO compatible country code, E.g. ie
    latitude		string	The decimal latitude of the search context (optional)
    longitude		string	The decimal longitude of the search context (optional)
    language		string	An ISO compatible language code, E.g. en

  • GET Entity Who Search /v1/entity/search/who

    Search for matching entities

    Parameter	Value	Type	Description
    who		string	Company name
    per_page		string	How many results per page
    page		string	What page number to retrieve
    country		string	Which country to return results for. An ISO compatible country code, E.g. ie

  • GET Advertiser Entity Search /v1/entity/advertisers

    Search for matching entities that are advertisers and return a random selection upto the limit requested

    Parameter	Value	Type	Description
    tag		string	The word or words the advertiser is to appear for in searches
    where		string	The location to get results for. E.g. Dublin
    limit		string	The number of advertisers that are to be returned
    country		string	Which country to return results for. An ISO compatible country code, E.g. ie
    language		string	An ISO compatible language code, E.g. en

  • GET Get a tokenised URL to report incorrect information on an entity /v1/token/report

    Allows an application to identify the correct URL to proceed to to report an issue

    Parameter	Value	Type	Description
    entity_id		string	The unique Entity ID
    portal_name		string	The name of the portal that the user is coming from
    language		string	An ISO compatible language code, E.g en

  • GET Get a tokenised URL to add an entity /v1/token/add

    Provides a personalised URL to redirect a user to add an entity to Central Index

    Parameter	Value	Type	Description
    language		string	The language to use to render the add path
    portal_name		string	The name of the website that data is to be added on

  • GET Get a tokenised URL to claim an entity /v1/entity/claim

    Provides a personalised URL to redirect a user to claim an entity on Central Index

    Parameter	Value	Type	Description
    entity_id		string	Entity ID to be claimed
    language		string	The language to use to render the claim path
    portal_name		string	The name of the website that the entity is being claimed on

  • GET Get a tokenised URL for messaging an entity /v1/token/message

    Fetch token for messaging path

    Parameter	Value	Type	Description
    entity_id		string	The id of the entity being messaged
    portal_name		string	The name of the application that has initiated the email process, example: 'Your Local'
    language		string	The language for the app

  • GET Return a publisher by masheryid /v1/publisher/by_masheryid

    Returns a publisher that has the specified masheryid

    Parameter	Value	Type	Description
    publisher_masheryid		string

  • GET Search for a keyword using an autocomplete method /v1/autocomplete/keyword

    The search matches a category name or synonym on a given string and language.

    Parameter	Value	Type	Description
    str		string	A string to search against, E.g. Plumbers
    language		string	An ISO compatible language code, E.g. en
    use_cache		string

  • GET Search for a category using an autocomplete method /v1/autocomplete/category

    The search matches a category name on a given string and language.

    Parameter	Value	Type	Description
    str		string	A string to search against, E.g. Plumbers
    language		string	An ISO compatible language code, E.g. en
    use_cache		string

  • GET Search for a location using an autocomplete method /v1/autocomplete/location

    The search matches a location name or synonym on a given string and language.

    Parameter	Value	Type	Description
    str		string	A string to search against, E.g. Dub
    country		string	Which country to return results for. An ISO compatible country code, E.g. ie
    use_cache		string