Probe API Client
Project description
Probe provides you access to information on all companies in India.
Data collected, cleaned and curated from multiple sources is made
available through our APIs now.
Come experience and build something awesome!
All endpoints are accessible only via https and are located at `api.probe42.in`
## Authentication
Once you've [registered your client](http://developer.probe42.in) it's easy to start requesting data from Probe.
You will be issued automatically an API key, which you can provide in all your calls.
It is very important to keep your API key as a secret and store it in a
private and secure location.
Sharing your API key is strictly prohibited.
The API key is unique to each customer and application.
Pass the API key in the request header \"x-api-key\".
Given below is an example of the curl command on how to pass the API key in the header:
```
curl -X GET --header \"Accept: application/json\" --header \"x-api-key: $api_key\" \"https://api.probe42.in/probe_lite/companies\"
```
## Limits
Be good. If you are sending too many requests too quickly, you will receive a 429 HTTP response.
We have rate-limiting set on our servers.
## Errors
The following are the typical errors returned:
403 - Forbidden when there's no api-key supplied, incorrect api-key or
an incorrect URL is given
422 - Validation errors - for eg., given a wrong CIN format
404 - when a resource is not found
500 - any server side error
503 - timeout errors - if we have some issue in our backend systems
Data collected, cleaned and curated from multiple sources is made
available through our APIs now.
Come experience and build something awesome!
All endpoints are accessible only via https and are located at `api.probe42.in`
## Authentication
Once you've [registered your client](http://developer.probe42.in) it's easy to start requesting data from Probe.
You will be issued automatically an API key, which you can provide in all your calls.
It is very important to keep your API key as a secret and store it in a
private and secure location.
Sharing your API key is strictly prohibited.
The API key is unique to each customer and application.
Pass the API key in the request header \"x-api-key\".
Given below is an example of the curl command on how to pass the API key in the header:
```
curl -X GET --header \"Accept: application/json\" --header \"x-api-key: $api_key\" \"https://api.probe42.in/probe_lite/companies\"
```
## Limits
Be good. If you are sending too many requests too quickly, you will receive a 429 HTTP response.
We have rate-limiting set on our servers.
## Errors
The following are the typical errors returned:
403 - Forbidden when there's no api-key supplied, incorrect api-key or
an incorrect URL is given
422 - Validation errors - for eg., given a wrong CIN format
404 - when a resource is not found
500 - any server side error
503 - timeout errors - if we have some issue in our backend systems
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
probe-py-1.1.2.tar.gz
(23.3 kB
view details)
File details
Details for the file probe-py-1.1.2.tar.gz
.
File metadata
- Download URL: probe-py-1.1.2.tar.gz
- Upload date:
- Size: 23.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e53a20759a951b17511ae458ae482a1db8c032c7e298006ae83658d1a4d6b982 |
|
MD5 | 855faa36c19d3ebe9e4b0054f6849013 |
|
BLAKE2b-256 | 06112b0327dc52e570da8ce62237453e1b8050a430c4a5e5ac04bbd989a8b393 |