Skip to content
This repository has been archived by the owner on Nov 27, 2022. It is now read-only.

Commit

Permalink
readme edits
Browse files Browse the repository at this point in the history
  • Loading branch information
l0iro committed Mar 28, 2016
1 parent fba2d59 commit e6db071
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,38 @@
[![Build Status](https://travis-ci.org/inquirimdotcom/inquisitor.svg?branch=master)](https://travis-ci.org/inquirimdotcom/inquisitor)
[![Wheel support](https://img.shields.io/pypi/wheel/inquisitor.svg)](https://pypi.python.org/pypi/inquisitor)
[![Python Versions](https://img.shields.io/pypi/pyversions/inquisitor.svg)](https://pypi.python.org/pypi/inquisitor)

### Brief

This Python module provides a python wrapper around the API of Inquirim.com.
Inquirim.com is an aggregator of economic data.

This API accepts requests provided an authentication token is supplied. To obtain an authentication token, users must register at inquirim.com.
This Python module provides a wrapper around the API of Inquirim.com.

Please, check out [Getting Started guide](https://github.com/inquirimdotcom/inquisitor/wiki/Getting-started).
To send requests to the API, users need to provide an authentication token, which can be obtained by registering at inquirim.com.

Documentation of the API and use examples can be found on the [documentation site](https://www.inquirim.com/docs/libraries#python).

### Installation

pip install inquisitor



### Example of use
### Quick examples

```
import inquisitor
api = inquisitor.Inquisitor("YOUR_API_KEY")
sources = api.sources(page=1)
for data in inquisitor.series(geography="France"):
print data.ticker
```
### Motivation
### List sources
api.sources(page = 1)
This project aims at complementing the effort to make access to economic data easier with the inquirim.com API.
### List datasets
api.datasets(source = 'EU')
### Obtain series data
api.series(dataset = 'FRED', page = 5)
```


### License
Expand Down

0 comments on commit e6db071

Please sign in to comment.