# [IBM X-Force Exchange library]
|![](https://exchange.xforce.ibmcloud.com/favicon.ico)|IBM Security X-FORCE Exchange library in Python 3. Search: threat_activities, threat_groups, malware_analysis, collector and industries. For others applications. See ![X-Force Exchange](//exchange.xforce.ibmcloud.com)|
|---|---|
# Install
```pip
pip3 install XForce
```
# Use
Using you API_KEY make a basic authentication. See ![documentation](https://api.xforce.ibmcloud.com/doc/). After make a base64 code → Key + : + Password:
```sh
printf "d2f5f0f9-2995-42c6-b1dd-4c92252da129:06c41d5e-0604-4c7c-a599-300c367d2090" | base64
# ZDJmNWYwZjktMjk5NS00MmM2LWIxZGQtNGM5MjI1MmRhMTI5OjA2YzQxZDVlLTA2MDQtNGM3Yy1hNTk5LTMwMGMzNjdkMjA5MAo=
```
Using API_KEY, call functions. See ![best praticles](https://medium.com/geekculture/python-separate-code-and-sensitive-information-elegantly-ae21cec5fae2) for key storage
## Call functions
```python3
import XForce
# Args: 1 - Term of search, 2 - API KEY
# Threat activity search return in string
XForce.threat_activities(Term, API_KEY)
# Malware analysis search return in string
XForce.malware_analysis(Term, API_KEY)
# Threat groups search return in string
XForce.threat_groups(Term, API_KEY)
# Industries search return in string
XForce.industries(Term, API_KEY)
# All categories search return in list with dict
XForce.industries(Term, API_KEY)
```
For see more details of consult, run:
```python3
from XForce import details
# Args: 1 - GUID, 2 - API KEY
# IMPORTANT: all GUID are correspondent to category
# All function of details have:
# url → with x-force exchange panel
details.activity(Id, API_KEY)
details.group(Id, API_KEY)
details.malware(Id, API_KEY)
details.industry(Id, API_KEY)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Jul10l1r4/x-force",
"name": "XForce",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "threat intelligence security ibm xforce x-force blueteam search query api exchange otx cti oct",
"author": "Julio Lira",
"author_email": "jul10l1r4@disroot.org",
"download_url": "https://files.pythonhosted.org/packages/15/5d/ae465e2b571f5196f7944c44470f702cd1b695c18533663914ab0b3073c2/XForce-0.7.tar.gz",
"platform": null,
"description": "# [IBM X-Force Exchange library]\n|![](https://exchange.xforce.ibmcloud.com/favicon.ico)|IBM Security X-FORCE Exchange library in Python 3. Search: threat_activities, threat_groups, malware_analysis, collector and industries. For others applications. See ![X-Force Exchange](//exchange.xforce.ibmcloud.com)|\n|---|---|\n\n# Install\n```pip\npip3 install XForce\n```\n\n# Use\nUsing you API_KEY make a basic authentication. See ![documentation](https://api.xforce.ibmcloud.com/doc/). After make a base64 code \u2192 Key + : + Password:\n```sh\nprintf \"d2f5f0f9-2995-42c6-b1dd-4c92252da129:06c41d5e-0604-4c7c-a599-300c367d2090\" | base64\n# ZDJmNWYwZjktMjk5NS00MmM2LWIxZGQtNGM5MjI1MmRhMTI5OjA2YzQxZDVlLTA2MDQtNGM3Yy1hNTk5LTMwMGMzNjdkMjA5MAo=\n``` \nUsing API_KEY, call functions. See ![best praticles](https://medium.com/geekculture/python-separate-code-and-sensitive-information-elegantly-ae21cec5fae2) for key storage\n\n## Call functions\n```python3\nimport XForce\n\n# Args: 1 - Term of search, 2 - API KEY\n\n# Threat activity search return in string\nXForce.threat_activities(Term, API_KEY)\n\n# Malware analysis search return in string\nXForce.malware_analysis(Term, API_KEY)\n\n# Threat groups search return in string\nXForce.threat_groups(Term, API_KEY)\n\n# Industries search return in string\nXForce.industries(Term, API_KEY)\n\n# All categories search return in list with dict\nXForce.industries(Term, API_KEY)\n```\n\nFor see more details of consult, run:\n```python3\nfrom XForce import details\n\n# Args: 1 - GUID, 2 - API KEY \n# IMPORTANT: all GUID are correspondent to category\n# All function of details have:\n# url \u2192 with x-force exchange panel\ndetails.activity(Id, API_KEY)\ndetails.group(Id, API_KEY)\ndetails.malware(Id, API_KEY)\ndetails.industry(Id, API_KEY)\n```\n\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "IBM Security utilitary library in python. Search and query all sources: threat_activities and groups, malware_analysis, industries",
"version": "0.7",
"split_keywords": [
"threat",
"intelligence",
"security",
"ibm",
"xforce",
"x-force",
"blueteam",
"search",
"query",
"api",
"exchange",
"otx",
"cti",
"oct"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b86567191bddae4a8a750b0a05f60b1dcfd9212299f2fb48b7bb48b73edd7409",
"md5": "7e6947d3ec5b2fff905bcd380922e2a9",
"sha256": "15368fff8fd07a41c7a41be291e472dba354363338d32f66c044bd737d663dfb"
},
"downloads": -1,
"filename": "XForce-0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e6947d3ec5b2fff905bcd380922e2a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 15410,
"upload_time": "2023-01-29T17:53:18",
"upload_time_iso_8601": "2023-01-29T17:53:18.834768Z",
"url": "https://files.pythonhosted.org/packages/b8/65/67191bddae4a8a750b0a05f60b1dcfd9212299f2fb48b7bb48b73edd7409/XForce-0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "155dae465e2b571f5196f7944c44470f702cd1b695c18533663914ab0b3073c2",
"md5": "6681c7746d348d2deef79ef50b4a2590",
"sha256": "84e0be068671637b31f382ae909f3140a467d588bd7c6621672a1981702c6e03"
},
"downloads": -1,
"filename": "XForce-0.7.tar.gz",
"has_sig": false,
"md5_digest": "6681c7746d348d2deef79ef50b4a2590",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15034,
"upload_time": "2023-01-29T17:53:21",
"upload_time_iso_8601": "2023-01-29T17:53:21.010584Z",
"url": "https://files.pythonhosted.org/packages/15/5d/ae465e2b571f5196f7944c44470f702cd1b695c18533663914ab0b3073c2/XForce-0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-29 17:53:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Jul10l1r4",
"github_project": "x-force",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "xforce"
}