Freebase API v1

Version: 5.3

Freebase API v1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you access the Freebase repository of open data. Google documentation.

(require gapi/macro)

(require-gapi-doc freebase.v1.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 topic

procedure
(freebase-topic-lookup #:id id
[ #:filter filter
#:lang lang
#:dateline dateline
#:limit limit
#:raw raw
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  id : string?
  filter : string? = 'N/A
  lang : string? = 'N/A
  dateline : string? = 'N/A
  limit : string? = 'N/A
  raw : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Get properties and meta-data about a topic.

id: The id of the item that you want data about.

filter: A frebase domain, type or property id, ’suggest’, ’commons’, or ’all’. Filter the results and returns only appropriate properties.

lang: The language you ’d like the content in - a freebase /type/lang language key.

dateline: Determines how up-to-date the data returned is. A unix epoch time, a guid or a ’now’

limit: The maximum number of property values to return for each property.

raw: Do not apply any constraints, or get any names.

2.2 text

procedure
(freebase-text-get #:id id
[ #:format format
#:maxlength maxlength
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  id : string?
  format : string? = 'N/A
  maxlength : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Returns blob attached to node at specified id as HTML

id: The id of the item that you want data about

format: Sanitizing transformation.

maxlength: The max number of characters to return. Valid only for ’plain’ format.