Introduction
This API call has been marked for deprecation. We are no longer supporting this API call.
Basic Syntax
Specify either the factual_id or a URL that references a place.
Examples
All examples below are shown with URL encoding for clarity. In practice, you will need to URL encode all GET parameters.
Run this example - foodiereview.com page
Required Parameters
There are no required parameters for the Crossref API call.
Optional Parameters
NOTE: At least one of the following is required:
Parameter Name | Description | Example |
|---|---|---|
factual_id | A Factual ID for an entity in the Factual Places data | factual_id=0000022c-4ab3-4f5d-8e67-6a6ff1826a93 |
| KEY | Your API Key. The KEY parameter is only required for non-OAuthenticated requests, which are supported purely as a debugging convenience. OAuth documentation is here. | KEY=Q3iBjOES4h1mZcNCZyBmQFcYREdjylIucvB3r2oI |
limit | The maximum rows to return. The default is 500. OAuth authentication is REQUIRED to exceed the default limit. | limit=5000. |
url | Any URL | url=https://www.loopt.com/places/stand-los-angeles-ca- |
NOTE:
- All examples are shown without URL Encoding for clarity.
- OAuth signing is optional for this request. If you do not sign your request, your request will be limited to system-wide defaults.
Responses
Successful Responses
Response Components
object | description |
|---|---|
version | Version of the API that generated this response |
response | Will return the number of rows in the included data packet and the reference data. |
response.included_rows | The number of rows in the included data packet. |
response.total_row_count | The total number of rows that fit your query. During beta, if total rows is greater than returned rows, there is significantly more data than expected and (likely) something is wrong. |
response.data[] | An array of entities that conform to the specified parameters sorted by URL |
response.data[per entity].factual_id | The Factual ID for this entity. |
response.data[per entity].url | A URL that relates directly to this entity. |
response.data[per entity].is_canonical | true if the URL specifically pertains to a single entity. false otherwise |
Sample Successful Response
Error Responses
Crosswalk Specific Error Messages and Causes
In addition to general Factual API errors, the following errors may be returned in response to GET requests:
HTTP Error Code | Factual Error Type | Message | Cause |
|---|---|---|---|
400 | InvalidFilterArgument | This request requires at least one of the following parameters: 'factual_id', 'url'. Documentation: http://developer.factual.com | The request does not include either factual_id, or url. |