Metadata-Version: 2.4
Name: ptapitester
Version: 0.0.6
Summary: API penetration testing tool (Penterep tool)
Home-page: https://www.penterep.com/
Author: Penterep
Author-email: vit.stankus@gmail.com
License: GPLv3+
Project-URL: homepage, https://www.penterep.com/
Project-URL: repository, https://github.com/Penterep/ptapitester
Project-URL: tracker, https://github.com/Penterep/ptapitester/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Environment :: Console
Classifier: Topic :: Security
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ptlibs>=1.0.25
Requires-Dist: ptthreads
Requires-Dist: PyYAML
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

[![penterepTools](https://www.penterep.com/external/penterepToolsLogo.png)](https://www.penterep.com/)


## PTAPITESTER

PTAPITESTER is a security testing tool for identifying vulnerabilities in different APIs

## Supported APIs

PTAPITESTER implements modules for testing the security of the following APIs:
- REST
- GraphQL
- XML-RPC
- SOAP

## Installation

```
pip install ptapitester
```

## Adding to PATH
If you're unable to invoke the script from your terminal, it's likely because it's not included in your PATH. You can resolve this issue by executing the following commands, depending on the shell you're using:

For Bash Users
```bash
echo "export PATH=\"`python3 -m site --user-base`/bin:\$PATH\"" >> ~/.bashrc
source ~/.bashrc
```

For ZSH Users
```bash
echo "export PATH=\"`python3 -m site --user-base`/bin:\$PATH\"" >> ~/.zshrc
source ~/.zshrc
```

## Usage examples
```
ptapitester -u htttps://www.example.com/
```

## Options
```
   [API_TYPE]                      Specify the target API for testing
               GRAPHQL             Module for GRAPHQL API testing
               SOAP                Module for SOAP API testing
               XMLRPC              Module for XMLRPC API testing
               REST                Module for REST API testing
                                     
   -v          --version           Show script version and exit
   -h          --help              Show this help message and exit
   -j          --json              Output in JSON format
   -u          --url        <URL>  Connect to URL
   -r          --redirects         Allow redirects
```

## Dependencies
```
ptlibs
ptthreads
PyYAML
```

## License

Copyright (c) 2025 Penterep Security s.r.o.

ptapitester is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

ptapitester is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with ptapitester. If not, see https://www.gnu.org/licenses/.

## Warning

You are only allowed to run the tool against the websites which
you have been given permission to pentest. We do not accept any
responsibility for any damage/harm that this application causes to your
computer, or your network. Penterep is not responsible for any illegal
or malicious use of this code. Be Ethical!
