CleanTalk API methods

This article describes public API methods by CleanTalk for spam and bot checking, for blacklist database access and for clients data manipulation.

Our cloud processes a big amount of data to recognise spammers, it's functionality is available for you by various API methods.

Real-time spam checking methods

There are 5 spam and bot checking core methods, they are fast so it's recommended to use them in a real time.

Single point of call for all of these methods is our moderate servers pool: https://moderate.cleantalk.org/api2.0 unless otherwise specified.

Spam and bot checking methods

• check_message -  to filter spam on forms that contain user-generated content (UGC) like a comment, review, or contact form.
• check_newuser -  to filter spam signups, polls, and eCommerce orders.
• check_bot - to filter bots in background during the simple page viewing.

Helper methods

• frontend_data - to collect the site visitor data in background for better working of previous methods.
• send_feedback - to send the result of your manual moderation to the CleanTalk cloud for better spam/not spam learning.

Auxiliary methods

There are many auxiliary methods. They provide an access to our cloud databases, give you control of your private lists and settings.

Single point of call for all of these methods is our API servers pool: https://api.cleantalk.org

Blacklist database access methods

These methods are intended to get various data from our databases.

• spam_check - to get an information about the status of IP address or e-mail in our blacklist database for a long period of time.
• spam_check_cms - CMS-related version of previous method.
• email_check - information about the existence of e-mail.
• email_check_cms - CMS-related version of previous method.
• ip_info - to get the country code of IP address.

Private lists control methods

These methods are intended to operate with private lists of our Anti-spam and Security products.

• private_list_add - to add a record in your private list.
• private_list_get - to get a list of records.
• private_list_update - to update a record.
• private_list_delete - to delete a record.

Site monitoring control methods

These methods are intended to operate with items of our Site Monitoring product.

• monitoring_services_add - to add a site for monitoring.
• monitoring_services_get - to get sites.
• monitoring_services_update - to update a site.
• monitoring_services_delete - to delete a site.

Setting templates control methods

These methods are intended to operate with templates of your local sites settings.

• services_templates_add - to add a template.
• services_templates_get - to get templates.
• services_templates_update - to update a template.
• services_templates_delete - to delete a template.
• services_templates_set - to set a template.