{"id":18365753,"url":"https://github.com/riskiq/python_api","last_synced_at":"2025-04-06T16:31:36.035Z","repository":{"id":20646335,"uuid":"23928323","full_name":"RiskIQ/python_api","owner":"RiskIQ","description":"Python client for RiskIQ API services","archived":false,"fork":false,"pushed_at":"2018-09-07T02:57:28.000Z","size":298,"stargazers_count":17,"open_issues_count":5,"forks_count":11,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-22T03:31:38.050Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://pythonhosted.org/riskiq/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RiskIQ.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-11T17:28:46.000Z","updated_at":"2022-04-28T00:47:05.000Z","dependencies_parsed_at":"2022-08-21T19:00:57.411Z","dependency_job_id":null,"html_url":"https://github.com/RiskIQ/python_api","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RiskIQ%2Fpython_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RiskIQ%2Fpython_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RiskIQ%2Fpython_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RiskIQ%2Fpython_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RiskIQ","download_url":"https://codeload.github.com/RiskIQ/python_api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247512711,"owners_count":20950906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T23:14:27.953Z","updated_at":"2025-04-06T16:31:35.668Z","avatar_url":"https://github.com/RiskIQ.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"riskiq \n======\n\n*Python client for RiskIQ API services*\n\n**riskiq** provides a Python client library implementation into RiskIQ API\nservices. The library currently provides support for the following services:\n\n- Passive DNS queries\n- Blacklist URL search\n- Blacklist Incident URL search\n- ZList download\n- Crawler *Landing Page* submission\n\nCommand-line scripts\n--------------------\n\nThe following command line scripts are installed with the library:\n\n- **riq-config**: utility to set or query API configuration options for the\n  library (API token and private key).\n- **riq-dns**: client to issue queries to the RiskIQ Passive DNS database service.\n- **riq-blacklist**: client to issue queries for domains and URLs to identify\n  listings in the RiskIQ blacklist.\n- **riq-zlist**: query the zlist for entries within a time range\n- **riq-landingpage**: get and submit new landing pages\n- **riq-binary**: list and download files from the binary feed\n\nSee the *Usage* section for more information.\n\nInstallation\n------------\n\nFrom the downloaded source distribution::\n\n    $ python setup.py install\n\nOr from PyPI::\n\n    $ pip install riskiq\n\nThe package depends on the Python Requests_ library.\nIf Requests is not installed, it will be installed as a dependency.\n\n.. _Requests: http://docs.python-requests.org/\n\nSetup\n-----\n\nFirst-time setup requires configuring your API token and private key for authentication::\n\n    $ riq-config setup \u003cAPI_TOKEN\u003e \u003cAPI_PRIVATE_KEY\u003e\n\nAt any time, the current API configuration parameters can be queried using the same utility::\n\n    $ riq-config show\n\nConfiguration parameters are stored in **$HOME/.config/riskiq/api_config.json**.\n\nUsage\n-----\n\nEvery command-line script has several sub-commands that may be passed to it. The\ncommands usage may be described with the ``-h/--help`` option.\n\nFor example::\n\n    $ riq-blacklist -h\n    usage: riq-blacklist [-h] {lookup,incident,incidentlist,list,malware} ...\n\n    positional arguments:\n      {lookup,incident,incidentlist,list,malware}\n        lookup              Query blacklist on URL\n        incident            Query blacklist incident on URL\n        incidentlist        query blacklist incidents within timeframe\n        list                query blacklisted resources\n        malware             Query for all discovered malware resources generated\n                            within a particular period.\n\n    optional arguments:\n      -h, --help            show this help message and exit\n\nEvery sub-command has further help options:::\n\n    $ riq-blacklist lookup -h\n    usage: riq-blacklist lookup [-h] [-l] [-j] urls [urls ...]\n\n    positional arguments:\n      urls\n\n    optional arguments:\n      -h, --help     show this help message and exit\n      -l, --oneline  Output one line per entry\n      -j, --json     Output as JSON\n\nAll commands will have the ``-j/--json`` option to return raw responses in JSON\nformat, which often contain more information than present in the default,\nhuman readable format.\n\nVersion History\n---------------\n\nVersions before 0.2.7 have been mostly base implementation and bug fixes.\nWe do not recommend using anything less than 0.2.7.\n\n:0.4.13:\n    Added support for passing custom filters when searching inventory\n:0.4.10:\n    Added support for whois history lookups in API.\n:0.4.9:\n    Added support for bulk blacklist lookups in API.\n:0.4.8:\n    Added custom jinja2 template option to CLI render script (--template/-T)\n    Fixed whitespace rendering when incidents are empty\n:0.4.7:\n    Hotfix for rendering bug\n:0.4.6:\n    Fixed multiple blacklist templates\n    Fixed verbose flag for riq-blacklist submodules\n:0.4.5:\n    Fixed bugs in riskiq.cli.blacklist scripts\n:0.4.4:\n    Refactored riskiq.cli.blacklist scripts\n:0.4.3:\n    Fixed issue where Python 2.6 sys.version_info is a tuple, not namedtuple.\n:0.4.2:\n    Fixed config bug\n:0.4.1:\n    Disable httplib if in Python 3+\n:0.4.0:\n    Working on Python 3 compatibility\n:0.3.2:\n    Updated ``riq-dns`` output formats. Default output format is now a\n    shortened one-line format per record. A more verbose one-line format\n    is available with the ``-v/--verbose`` option. The previous text-based\n    \"human-readable\" format is available using the ``-T/--text`` option.\n:0.2.7:\n    Fixed template bug in ``riq-landingpage submit``\n:0.2.6:\n    Fix landingpage submissions to allow md5, project, keyword, fields\n:0.2.5:\n    Added binary download options --output and --output-dir\n    8f540b0 List and download suspicious binaries via CLI\n    fix MANIFEST.in installation bug\n:0.2.3:\n    Documentation changes\n:0.2.1:\n    Added documentation\n:\u003c= 0.2.0:\n    Most implementation of CLI tools and client API\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friskiq%2Fpython_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Friskiq%2Fpython_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friskiq%2Fpython_api/lists"}