Official Militant SDKs

The official SDKs help you integrate the Militant API quickly into Python and JavaScript/Node.js projects.

What they are for

• launching a bot, worker or automation script quickly
• connecting Militant to a Python, Node.js or React Native application
• using the endpoints without rebuilding the whole HTTP and auth layer
• building admin, moderation or export tools

Available SDKs

Python SDK

• File: militant.py
• Documentation: Python README on GitLab
• Dependencies: requests
• Use cases: scripts, bots, Python backend applications

JavaScript SDK

• File: militant.js
• Documentation: JavaScript README on GitLab
• Dependencies: axios
• Use cases: Node.js, web apps, React Native

Bots and automation

• Included example: Keyword Relay Bot
• Path: examples/bots/keyword-relay-bot
• Use cases: topic monitoring, alert relaying, light moderation, operator account workflows

Quick install

Python

mkdir -p vendor/militant-sdk
curl -fsSLo vendor/militant-sdk/militant.py https://gitlab.com/militant1/militant-api/-/raw/main/sdk/python/militant.py
pip install requests

JavaScript

mkdir -p vendor/militant-sdk
curl -fsSLo vendor/militant-sdk/militant.js https://gitlab.com/militant1/militant-api/-/raw/main/sdk/javascript/militant.js
npm install axios

Quick integration

Python

import sys
sys.path.append('./vendor/militant-sdk')
from militant import MilitantClient

JavaScript

const MilitantClient = require('./vendor/militant-sdk/militant');

If you prefer a very small project layout, place militant.py or militant.js directly at your project root.

Example usage

Python

from militant import MilitantClient
client = MilitantClient('https://militant.revlibertaire.com')
user = client.login('username', 'password')
timeline = client.get_timeline()
post = client.create_post('Hello from Python!')

JavaScript

const MilitantClient = require('./militant');
(async () => {
  const client = new MilitantClient('https://militant.revlibertaire.com');
  const user = await client.login('username', 'password');
  const timeline = await client.getTimeline();
  const post = await client.createPost('Hello from JavaScript!');
})();

Covered features

The two SDKs cover a large part of the API and act as the main integration layer for common use cases:

Authentication

• login/logout with JWT token
• token refresh
• token revocation

Social content

• posts, comments, reactions
• likes, shares and bookmarks
• stories
• multilingual translation

Users and relations

• user profiles
• followers/following
• friend requests
• private messages
• message groups

Groups and pages

• group creation and management
• group posts and comments
• page creation and management
• page posts

Media and events

• media upload
• photo albums
• live streaming
• events

Moderation and security

• reports
• moderator votes
• sanctions
• 2FA
• user preferences
• data export

Audio and video calls (Flutter only)

• one-to-one audio/video calls
• group calls
• WebRTC signaling through the API
• ICE restart for network mobility
• Note: requires the X-Flutter-App: militant-flutter-v1 header

Note:

• some very recent endpoints can appear in the API before both SDKs expose them
• these SDKs should be treated as the main integration layer, but not as 100% immediate coverage

Detailed documentation

• Python documentation - full guide with Python examples
• JavaScript documentation - full guide with JavaScript examples
• API endpoints - list of all available endpoints

Security

• all calls should use HTTPS
• JWT token authentication
• automatic rate limiting
• 2FA support
• secure token handling

Multilingual support

The API and SDKs support:

• French
• English
• Spanish
• Esperanto

Typical use cases

Moderation bot

client = MilitantClient('https://militant.revlibertaire.com')
client.login('bot_username', 'bot_password')
reports = client.get_reports()
for report in reports['data']:
    if report['reason'] == 'spam':
        client.vote_on_report(report['id'], 'approve')

Web application

const client = new MilitantClient('https://militant.revlibertaire.com');
await client.login(username, password);
const timeline = await client.getTimeline(1, 20);
displayPosts(timeline.posts);

Export script

client = MilitantClient('https://militant.revlibertaire.com')
client.login('username', 'password')
data = client.export_data()

Report a bug

Open an issue on GitLab:

• militant-api

Contribution

Contributions are welcome: 1. Fork the project on GitLab 2. Create a feature branch 3. Commit your changes 4. Push the branch 5. Open a merge request

License

The SDKs are distributed under the same license as the Militant API. See LICENSE at the project root.

Useful links

• Wiki home
• API installation
• First API call
• Endpoints list
• FAQ

---