Skip to main content

Simple Python implementation of WebFinger client protocol

Project description


A simple Python client implementation of `WebFinger RFC 7033 <>`_.

WebFinger is a discovery protocol that allows you to find information about people or things in a standardized way. See the `spec <>`_ or ` <>`_ for more information.


>>> from webfinger import finger
>>> wf = finger('')
>>> wf.subject
>>> wf.rels["profile"]
[{'rel': '', 'type': 'text/html', 'href': ''}]
>>> wf.aliases
['', '']


pip install git+


finger(resource, rel=None)
*finger* is a convenience method for instantiating a WebFingerClient object and making the request. The *resource* parameter is a URI of the resource about which you are querying. The optional *rel* parameter can be either a string or a list of strings that will limit the response to the specific relations. WebFinger servers are **not** required to obey the *rel* parameter, so you should handle the response accordingly.

WebFingerClient supports additional options, so check that out if *finger* does not meet your needs.

WebFinger Client

WebFingerClient(timeout=None, official=False)
Instantiates a client object. The optional *timeout* parameter specifies the HTTP request timeout. The optional *official* parameter is a boolean that determines if the client will use `unofficial endpoints`_.

finger(resource, host=None, rel=None, raw=False)
The client *finger* method prepares and executes the WebFinger request. *resource* and *rel* are the same as the parameters on the standalone *finger* method. *host* should only be specified if you want to connect to a host other than the host in the resource parameter. Otherwise, this method extracts the host from the *resource* parameter. *raw* is a boolean that determines if the method returns a WebFingerResponse object or the raw JRD response as a dict.

If the *host* parameter is passed to this method, unofficial endpoints are ignored. You're asking for a specific host so who am I to disagree?

WebFinger Response

The WebFinger response object provides handy properties for easy access and the raw JRD response. Read the `spec for specifics of the JRD response <>`_.


The URI of the thing that the response JRD describes.

A list of additional URIs that identify the subject.

A dict of URIs and values that provides information about the subject.

A list of objects that define external resources for the subject..

An ordered dictionary containing a list of objects referenced by the given relation name (or friendly name).

A dict of the raw JRD response.


rel(relation, attr='href')
A convenience method that provides basic access to links. The *relation* parameter is a URI for the desired link. The *attr* parameter is the key of the returned value of the link that matches *relation*. Returns a string if *relation* and *attr* exist, otherwise *None*.


>>> wf.rel('')

The response JRD may have multiple entries with the same relation URI. The *rel* method will select the first one, since order is meant to imply priority. If you need to see all of the values, you'll have to iterate over the *links* property and pull them out yourself.


>>> rel = ''
>>> [l.get('href') for l in rel.links if l.get('rel') == rel]

If *attr* is None, the full dict for the link will be returned.

Relation Properties

The following common link relation types are supported as properties of the response object:

* activity_streams:
* avatar:
* hcard:
* open_id:
* opensocial:
* portable_contacts:
* profile:
* webfist:
* xfn:


>>> wf.avatar


* `requests <>`_


python-webfinger is distributed under the `BSD license <>`_.

See LICENSE for the full terms.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for webfinger2, version 2.1
Filename, size File type Python version Upload date Hashes
Filename, size webfinger2-2.1.tar.gz (6.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page