Links
🤬

Profanity Detection

Overview

This method can be used to detect abuse of your website/app. It's a great way to know more about your user inputs and whether they contain profanity (bad words) or not before releasing them to the public.

Usage

You can simply use this method by using the badWords method instead of IPLookup or GeoIP that we described before, then you pass the text you want to filter. Let's take an example:
https://gregeoip.com/badWords?key=YourKey&text=This is just a testing text
get
https://gregeoip.com
/badWords

Options

Parameter
Description
key
Your API Key.
text
The text you want to filter.
scoreOnly
Returns only the score of the text and whether it's safe or not.
Accepts: yes or no
Default: no
listBadWords
Used to list the bad words as an Array.
Accepts: yes or no
Default: no
format
Used to choose the response format of the API.
Accepts: XML, JSON or CSV
Default: JSON
mode
Lets you use our Development Environment to test the API without affecting your available requests (Learn more).
callback
Tells the API to return the response as a callback function (Check out Callback section).
This method returns a score for the text you pass.
We classify profanity into 3 different level. The first level contains the most risky words and phrases (risky). The second level contains the medium-risk words and phrases. Whereas, the third level contains the low-risk words.
When you use the API, the response will the determine the score of the text you passed>
  • `riskScore = 0` means that this text is completely safe.
  • `riskScode = 1` means that this is a high-risk text.
  • `riskScode = 2` means that this is a medium-risk text.
  • `riskScode = 3` means that this is a low-risk text.