Skip to main content

Abstraction class to use Isogeo REST API

Project description

Python minimalist SDK to use Isogeo REST API

.. image::
.. image::
.. image::
.. image::
:alt: Travis build status

Unofficial lib.
API keys are required to use it.

Getting API keys

`Send us your request by email <>`_.

Getting Help

There is a basic documentation about the `Isogeo API <>`_.


To use:

.. code-block:: shell

pip install --user isogeo-pysdk

For developers:

.. code-block:: shell

git clone
cd isogeo-api-py-minsdk
python install


.. code-block:: python

from isogeo_pysdk import Isogeo

# authentify the application
isogeo = Isogeo(client_id=app_id,

# get available subresources

# get the token
token = isogeo.connect()

# search within catalogs shared to the application
search =

print("Search __dict__ keys: ", search.keys())
print("Search query parameters: ", search.get('query'))
print("Total count of metadatas shared: ", search.get("total"))
print("Count of resources got by request: {}\n".format(len(search.get("results"))))

Others samples are available in `the source repository <>`_.

Isogeo API coverage


- [X] group application (oAuth2 Credentials Grant)
- [ ] user confidential application (oAuth2 Authorization Code Grant)
- [ ] user public application (oAuth2 Implicit Grant)
- [X] token auto refresh

Resources search ( GET /resources/search )

Resources search parameters:

- [X] q (query)
- [X] ob (order by)
- [X] od (order direction)
- [X] _id (filter on specific resources id list)
- [X] _include (subresources management)
- [X] _lang (French or English with complete translation)
- [X] _limit (results length)
- [X] _offset (pagination)
- [X] box (filter on WGS84 boundging box)
- [X] geo (filter on WKT polygon)
- [X] rel (geometric operation to apply on 2 previous filters)
- [X] s share segregation

Resource details ( GET /resources/{rid} )

Resource detailed parameters:

- [X] id (metadata UUID)
- [X] _include (subresources management)


- [X] download resource in XML ISO-1939 version
- [ ] resource with contacts subresource included ( GET /resources/{rid}/contacts )
- [ ] resource with events subresource included ( GET /resources/{rid}/events )
- [ ] resource with keywords subresource included ( GET /resources/{rid}/keywords )
- [ ] resource with operations subresource included ( GET /resources/{rid}/operationds - only for services)

Keyword details ( GET /keyword/{kid} )

- [X] kid (keyword UUID)
- [X] _include (subresources management)
- [X] searches for keywords in a specific workgroup ( GET /groups/{gid}/keywords/search )

These requests are not publicly available.

Thesaurus ( GET /thesauri )

- [X] list of available thesauri
- [X] specific thesaurus ( GET /thesauri/tid )
- [X] searches for keywords in a specific thesaurus ( GET /thesauri/{tid}/keywords/search )

Shares ( GET /shares )

- [X] list accessible shares
- [X] specific share ( GET /shares/sid )

Miscellaneous & bonus

- [X] check API version
- [X] check database version
- [X] pick between different Isogeo API platform (PROD, QA, [INT])
- [X] set protocol requests to HTTPS (default) or HTTP (only for GET requests not for authentication)
- [X] get every API label automatically translated (not only INSPIRE themes)
- [X] additional search parameter to automatically get full results without have to iterate with _limit and _offset
- [X] option (`ALL`) to quickly get every subresources through _include parameter
- [X] method to easily download Isogeo hosted data
- [-] handle proxies setting (only for basic auth - not PAC nor NTLM)

Project details

Download files

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

Source Distribution

isogeo-pysdk-2.18.0.post490.tar.gz (30.9 kB view hashes)

Uploaded source

Built Distribution

isogeo_pysdk-2.18.0.post490-py2.py3-none-any.whl (25.9 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page