For more information on the Linkscape API in general, please consult the wiki
The lsapi class is initialized with your access id and your secret key, and then can be used to make API calls:
import linkscape
client = linkscape.client('my_access_id', 'my_secret_key')
# Now I can make me some API calls!
All calls in this class return the deserialized json objects that the API returns. Typically these are either dictionaries, or lists of dictionaries. For the meaning of each of the resultant keys, consult the documentation.
The columns you can request are a bitmask, with constants provided in classes
in the lsapi class. For example, the columns for URL Metrics and Anchor Text
API calls are in lsapi.UMCols and lsapi.ATCols respectively.
The first API call exposed is URL Metrics. It can provide summary information on a single (via a GET) or multiple (via a POST) url or urls.
# Let's get some urlmetrics. Results are now an array of dictionaries
# the i'th dictionary is the results for the i'th URL
metrics = client.urlMetrics(['www.seomoz.org', 'www.seomoz.org/blog'])
# Now let's say we only want specific columns in the results
authorities = client.urlMetrics(['www.seomoz.org'], linkscape.UMCols.domainAuthority | linkscape.UMCols.pageAuthority)
# Or if you just need results for one URL
mozMetrics = client.urlMetrics('www.seomoz.org')
Next exposed is the Anchor Text call, which returns a set of anchor text terms of phrases aggregated across links to a page or domain.
# Now for some anchor text results
anchorResults = client.anchorText('www.seomoz.org/blog')
# Or for just specific columns
anchorTermResults = client.anchorText('www.seomoz.org/blog', cols=linkscape.ATCols.term)
Lastly, we have the Links call, which returns a set of links to a page or domain.
# Now for some links results
links = client.links('www.seomoz.org')
# The links API has more columns to specify, as well as sort, scope, etc.
links = client.links('www.seomoz.org', scope='domain_to_domain', sort='domain_authority',
filters=['external', 'nofollow'], targetCols = linkscape.UMCols.url)