apiverve / profanityfilter

1.2.5 2026-11-09 17:46 UTC

Requires

• php: >=7.4
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• APIVerve

• api
• apiverve
• profanityfilter
• profanity filter api
• bad word filter api
• profanity check api
• profanity detection api
• profanity api

Published on Packagist.org on 2026-11-09 21:36 UTC

README

Profanity Filter is a bad word filter API that scans text for offensive language and masks detected swear words with a chosen replacement character. It returns the sanitized text and a boolean flag indicating if profanity was present. Paid plans add the count of filtered words, each matched word with its position, and custom allow and block word lists.

The Profanity Filter API provides a simple, reliable way to integrate profanity filter functionality into your applications. Built for developers who need production-ready profanity filter capabilities without the complexity of building from scratch.

View API Details →

Available on:

Quick Start

Using JavaScript

async function callProfanityFilterAPI() {
    try {
        const requestBody = {
    "text": "Today is so damn hot! Why the hell would anyone go outside?",
    "mask": "*",
    "details": true
};

        const response = await fetch('https://api.apiverve.com/v1/profanityfilter', {
            method: 'POST',
            headers: {
                'x-api-key': 'YOUR_API_KEY_HERE',
                'Content-Type': 'application/json'
            },
            body: JSON.stringify(requestBody)
        });

        const data = await response.json();
        console.log(data);
    } catch (error) {
        console.error('Error:', error);
    }
}

callProfanityFilterAPI();

Using cURL

curl -X POST "https://api.apiverve.com/v1/profanityfilter" \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Today is so damn hot! Why the hell would anyone go outside?",
    "mask": "*",
    "details": true
}'

Get your API key: https://apiverve.com

📁 For more examples, see the examples folder

Installation

Choose your preferred programming language:

📦 NPM (JavaScript/Node.js)

npm install @apiverve/profanityfilter

View NPM Package → | Package Code →

🔷 NuGet (.NET/C#)

dotnet add package APIVerve.API.ProfanityFilter

View NuGet Package → | Package Code →

🐍 Python (PyPI)

pip install apiverve-profanityfilter

View PyPI Package → | Package Code →

💎 Ruby (RubyGems)

gem install apiverve_profanityfilter

View RubyGems Package → | Package Code →

🐘 PHP (Packagist)

composer require apiverve/profanityfilter

View Packagist Package → | Package Code →

🎯 Dart (pub.dev)

dart pub add apiverve_profanityfilter

View pub.dev Package → | Package Code →

🤖 Android (JitPack)

implementation 'com.github.apiverve:profanityfilter-api:1.0.0'

Package Code →

🐹 Go

go get github.com/apiverve/profanityfilter-api/go

Package Code →

Why Use This API?

Feature	Benefit
Multi-language SDKs	Native packages for JavaScript, Python, C#, Go, and Android
Simple Integration	Single API key authentication, consistent response format
Production Ready	99.9% uptime SLA, served from 24 global regions
Comprehensive Docs	Full examples, OpenAPI spec, and dedicated support

Documentation

• 🏠 API Home: Profanity Filter API
• 📚 API Reference: docs.apiverve.com/ref/profanityfilter
• 📖 OpenAPI Spec: openapi.yaml
• 💡 Examples: examples/

What Can You Build?

The Profanity Filter API is commonly used for:

• Web Applications - Add profanity filter features to your frontend or backend
• Mobile Apps - Native SDKs for Android development
• Automation - Integrate with n8n, Zapier, or custom workflows
• SaaS Products - Enhance your product with profanity filter capabilities
• Data Pipelines - Process and analyze data at scale

API Reference

Authentication

All requests require an API key in the header:

x-api-key: YOUR_API_KEY_HERE

Get your API key: https://apiverve.com

Response Format

Every APIVerve endpoint returns the same envelope — check status, then read data:

{
  "status": "ok",
  "error": null,
  "data": { ... }
}

Example Response

A real response from the Profanity Filter API:

{
  "status": "ok",
  "error": null,
  "data": {
    "isProfane": true,
    "filteredText": "Today is so **** hot! Why the **** would anyone go outside?",
    "mask": "*",
    "trimmed": false,
    "profaneWords": 2,
    "matches": [
      {
        "word": "damn",
        "start": 12,
        "end": 16
      },
      {
        "word": "hell",
        "start": 30,
        "end": 34
      }
    ]
  }
}

Support & Community

• 🏠 API Home: Profanity Filter API
• 💬 Support: https://apiverve.com/contact
• 🐛 Issues: GitHub Issues
• 📖 Documentation: https://docs.apiverve.com
• 🌐 Website: https://apiverve.com

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Security

For security concerns, please review our Security Policy.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Built with ❤️ by APIVerve

Copyright © 2026 APIVerve. All rights reserved.