Build on Aube
Connect, message, transact, and introduce people through Aube's API. Build bots, integrations, and experiences that bring people together.
GET /api/v1/wallet/balance
{
"balance": 42.58,
"is_subscribed": true
}Connect, message, transact, and introduce people through Aube's API. Build bots, integrations, and experiences that bring people together.
GET /api/v1/wallet/balance
{
"balance": 42.58,
"is_subscribed": true
}Standard REST endpoints with JSON responses. Easy to integrate with any language or framework you're already using.
Secure authentication using API keys. Generate keys in the app, include them in your requests, and you're ready to go.
Smart rate limiting per endpoint type. General: 100/min, Messages: 30/min, Contacts: 20/hour, Intros: 10/hour.
Full access to balances, transactions, and the UBI system. Send money by PIN, accept or decline transfers.
Full messaging API. Create conversations, send messages, build chatbots and integrations.
Introduce people to each other. Recipients accept or decline. When all accept, a conversation is created.
Manage your contact list. Send requests, accept or decline. Contacts require mutual acceptance.
All API requests require authentication using an API key. Create keys in the Aube app under Settings → Developer.
Include your API key in the X-API-Key header, or use Bearer token authentication.
X-API-Key: aube_your_api_key_hereEverything you need to build on Aube
/wallet/balanceGet the current wallet balance, subscription status, and Shmita info.
{
"balance": 42.58,
"subscription_days": 45.2,
"is_subscribed": true,
"next_shmita": "2029-09-09"
}/wallet/sendSend money to another user by their PIN code.
{
"recipient_pin": "ABC123",
"amount": 5.0,
"note": "Thanks!"
}/wallet/transactionsGet transaction history including sent and received transfers.
{
"transactions": [
{ "amount": 5.0, "status": "accepted" }
]
}/wallet/pendingGet pending incoming transfers waiting for your response.
{
"pending_transactions": [
{ "amount": 10.0, "sender_pin": "XYZ789" }
]
}/wallet/transactions/:id/acceptAccept an incoming transfer. The amount is added to your balance.
{
"message": "Transfer accepted",
"transaction": { "status": "accepted" }
}/wallet/transactions/:id/declineDecline an incoming transfer. Funds are refunded to sender.
{
"message": "Transfer declined",
"transaction": { "status": "declined" }
}/wallet/subscriptionGet your subscription status and dates.
{
"is_subscribed": true,
"status": "active",
"start_date": "2026-01-01",
"end_date": "2026-02-01"
}/messages/sendSend a direct message by PIN. Creates conversation if needed.
{
"recipient_pin": "ABC123",
"content": "Hello!"
}/conversationsList all your conversations with participants and last message.
{
"conversations": [
{ "id": "...", "participants": [...] }
]
}/conversationsCreate a conversation or group by PIN codes.
{
"participant_pin": "ABC123"
}
// Or for groups:
{
"participant_pins": ["ABC", "XYZ"],
"name": "My Group"
}/conversations/:idGet a specific conversation with participants and last message.
{
"id": "...",
"participants": [...],
"last_message": {...}
}/conversations/:id/messagesGet messages in a conversation. Supports polling with ?since=timestamp.
{
"messages": [
{ "content": "Hi!", "sender": {...} }
],
"timestamp": 1234567890
}/conversations/:id/messagesSend a message to a conversation. Rate limited: 30/min.
{
"content": "Hello everyone!"
}/introductionsIntroduce 2+ people by PIN. Rate limited: 10/hour.
{
"participant_pins": ["ABC123", "XYZ789"],
"message": "You should meet!"
}/introductionsGet all your introductions (sent and received).
{
"introductions": [
{ "id": "...", "introducer": {...} }
]
}/introductions/pendingGet introductions waiting for your response.
{
"introductions": [
{ "introducer": {...}, "participants": [...] }
]
}/introductions/:id/acceptAccept an introduction. When all accept, a conversation is created.
{
"id": "...",
"conversation_id": "..." // when all accepted
}/introductions/:id/declineDecline an introduction.
{
"id": "...",
"status": "declined"
}/contactsGet your accepted contacts list.
{
"contacts": [
{ "id": "...", "contact": {...} }
]
}/contacts/requestSend a contact request by PIN. Rate limited: 20/hour.
{
"pin_code": "ABC123"
}/contacts/requests/pendingGet incoming contact requests waiting for your response.
{
"requests": [
{ "id": "...", "requester": {...} }
]
}/contacts/requests/:id/acceptAccept an incoming contact request. Creates mutual contact.
{
"message": "Contact request accepted"
}/contacts/requests/:id/declineDecline an incoming contact request.
{
"message": "Contact request declined"
}/contacts/:idRemove a contact from your list (removes mutual connection).
{
"message": "Contact removed"
}/contacts/check/:pinCheck if a user (by PIN) is in your contacts.
{
"is_contact": true,
"user": { "id": "...", "display_name": "..." }
}/meGet your profile info (display name, PIN code).
{
"id": "...",
"display_name": "John",
"pin_code": "ABC123"
}All endpoints are prefixed with this URL
https://api.aube.run/api/v1Different endpoints have different limits
Standard HTTP status codes
Download the app to create your API key and start building on Aube.