Skip to end of metadata
Go to start of metadata

Introduction

The Factual API is accessed through a RESTful interface.

The following is a sample Factual API request:

NOTE: All requests on this page are shown without URL encoding. Any request the Factual API should be URL Encoded.

Composing requests

API Server

 http://api.v3.factual.com/t/places/read?limit=50&filters={"name":"Bar Hayama"}

Requests to version 3 of the Factual API go to http://api.v3.factual.com. Version 3 is the latest shipping version of the Factual API.

Namespace

 http://api.v3.factual.com/t/places/read?limit=50&filters={"name":"Bar Hayama"}

Currently there are three namespaces that the API operates on:

  • All Factual tables are located under /t
  • The Places API endpoints are located within /places (not to be confused with /t/places which is the "places" table)

Table Name or Table Id

 http://api.v3.factual.com/t/places/read?limit=50&filters={"name":"Bar Hayama"}

The Optional name of the table you are accessing. Examples:

  • /places (US place data)
  • /global (Global place data)
  • /restaurants-us (US restaurant data)
  • /health-care-providers-us (US doctors data)
  • /products-cpg (Consumer Packaged Goods data)

Method

 http://api.v3.factual.com/t/places/read?limit=50&filters={"name":"Bar Hayama"}

Specifies the type of action you are requesting a response to.

  • If you do NOT specify a method and perform an HTTP GET request, you will receive the default action for the appropriate end point.
  • Methods are documented fully within the Core API docs and the Places API docs.

Parameters

 http://api.v3.factual.com/t/places/read?limit=50&filters={"name":"Bar Hayama"}
  • All parameters passed into Factual API requests are case sensitive.
  • The API documentation specifies which parameters are required and which are optional.
  • The value passed into any parameter should be URL encoded separately individually. For example, in the request above, {"name":"Bar Hayama"} should be URL Encoded before setting it to the value of filters.
Labels
  • None