Metadata-Version: 2.1
Name: tianyancha
Version: 0.2.1
Summary: Tianyancha SDK for python, which based on https://open.tianyancha.com/
Home-page: https://github.com/iamsk/tianyancha
Author: Bin
Author-email: iamsk.info@gmail.com
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pytest>=3.6.4
Requires-Dist: requests>=2.12.4
Requires-Dist: retry>=0.9.2
Requires-Dist: python-dotenv>=1.0.1


# tianyancha - 天眼查 API

Tianyancha SDK for python, which based on https://open.tianyancha.com/

## install

```shell script
pip install tianyancha
```

## Usage

All API supported! please visit **[Supported methods](API.md)** for more information!

```python
from tianyancha import Tianyancha

token = "TOKEN"
word = "北京百度网讯科技有限公司"
tyc = Tianyancha(token)
ret = tyc.search(word=word)  # Limited to use `keyword arguments`
```

```json
{
  "error_code": 0,
  "reason": "ok",
  "result": {
    "items": [
      {
        "regNumber": "110108002734659",
        "regStatus": "在业",
        "creditCode": "91110000802100433B",
        "estiblishTime": "2001-06-05 00:00:00.0",
        "regCapital": "1342128万人民币",
        "companyType": 1,
        "name": "<em>北京百度网讯科技有限公司</em>",
        "id": 22822,
        "orgNumber": "802100433",
        "type": 1,
        "base": "北京",
        "legalPersonName": "梁志祥"
      },
      {
        "regNumber": "440106000623068",
        "regStatus": "在业",
        "creditCode": "91440101675657502F",
        "estiblishTime": "2008-05-20 00:00:00.0",
        "regCapital": "-",
        "companyType": 1,
        "name": "<em>北京百度网讯科技有限公司</em>广州分公司",
        "id": 139572971,
        "orgNumber": "675657502",
        "type": 1,
        "base": "广东",
        "legalPersonName": "沈抖"
      },
      ...
    ],
    "total": 56
  }
}
```

## More usages

Request APIs as below, they are equal:

```python
ret1 = tyc.get('ic/changeinfo/2.0', {'keyword': keyword})
ret2 = tyc.ic_changeinfo(keyword=keyword)
```

Sync newest APIs from official website and update document.

```shell
python tianyancha/sync.py > API.md
```

## Tests

just run `pytest`

## Changelog

* 2024-09-23 0.2.1 sync new methods from tianyancha.com
* 2020-12-11 0.1.2 path bugfix and generate documents for all methods
* 2020-12-11 0.1.1 support all methods
* 2020-12-11 0.1.0 support basic search for tianyancha

## Refs

Official API Document: https://open.tianyancha.com/api_list
