API Key Access Required
You need to be logged in to view and manage your API keys.
Please sign in to your account to access your developer tools.
Secure Access
Your API keys are protected with enterprise-grade securityDeveloper Tools
Access powerful APIs to integrate with our platformUsage Analytics
Monitor your API usage and performance metricsAPI Documentation
Getting Started with the API
Welcome to the Eclesiar API documentation. This API allows you to interact programmatically with the Eclesiar platform.
Authentication
All API requests require authentication using an API Key. You can generate your API Key in the "API Key Management" section above. Once you have your API Key, include it in the Authorization header of every request.
Authorization: Bearer your_api_key_here
Base URL
All API endpoints are relative to the base URL:
https://api.eclesiar.com
Response Format
All responses are returned in JSON format. Successful responses will have a code of 200 and include a data field. Error responses will have an appropriate HTTP status code and include a description field describing the error.
{
"code": 200,
"description": "Success",
"data": [
"..."
]
}
Rate Limits
There are currently no strict rate limits, but please be mindful of the number of requests you make. Excessive usage may result in temporary restrictions. You can monitor your monthly request count in the API Key Management panel above.
Getting Started
To get started with the API:
- Generate your API Key using the "Generate New Key" button above
- Include your API Key in the
Authorizationheader as shown in the authentication example - Browse the available endpoints below to find the data you need
- Make your first request and start building!
Endpoint URL
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"status": "ok",
"version": "1.3.0",
"server_name": "Eclesiar",
"server_time": "01:00:00",
"server_day": 125
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
page |
integer | The page number for pagination |
1
|
Optional |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"id": 1,
"name": "Bread",
"quality": 5,
"type": "FOOD",
"avatar": "https://example.com/avatars/food.png"
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
page |
integer | The page number for pagination |
1
|
Optional |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"id": 1,
"slot": 3,
"grade": 2,
"critical_chance": 0,
"critical_hit": 0,
"damage_percentage": 0,
"true_damage": 70,
"flatland_damage_percentage": 0,
"mountains_damage_percentage": 0,
"forest_damage_percentage": 0,
"desert_damage_percentage": 0,
"accuracy": 0,
"drop_chance": 0,
"construction_percentage": 0,
"hospital_construction_percentage": 0,
"militarybase_construction_percentage": 0,
"productionfields_construction_percentage": 0,
"industrialzone_construction_percentage": 0,
"construction_item_donation_percentage": 0,
"mining_gold_percentage": 0,
"construction_energy_reduction_percentage": 0,
"avatar": "https://example.com/avatars/equipment.png",
"drop_category": "MILITARY"
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
currency_id |
integer | The ID of the currency to filter offers by | - | Required |
transaction |
string |
The type of transaction to filter offers by (BUY or SELL)
Allowed values:
BUY
SELL
|
BUY
|
Optional |
page |
integer | The page number for pagination |
1
|
Optional |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"rate": 0.3,
"amount": 100,
"owner": {
"id": 1,
"type": "account"
}
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
country_id |
integer | The ID of the country to filter offers by | - | Required |
item_id |
integer | The ID of the item to filter offers by | - | Required |
page |
integer | The page number for pagination |
1
|
Optional |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"value": 0.3,
"amount": 100,
"owner": {
"id": 1,
"type": "account"
}
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
country_id |
integer | The ID of the country to filter offers by | - | Required |
page |
integer | The page number for pagination |
1
|
Optional |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"value": 23.001,
"amount": 18,
"economic_skill": 0,
"currency_id": 12,
"business_id": 8278
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
finished |
integer | Whether to shows finished auctions (0 for no, 1 for yes) |
0
|
Optional |
page |
integer | The page number for pagination |
1
|
Optional |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"id": 102122,
"item": {
"id": 93,
"type": "equipment"
},
"owner": {
"id": 7792,
"type": "account"
},
"initial_bid": 1,
"created_at": "2025-06-03 11:32:52",
"end_at": "2025-06-05 11:32:52",
"status": 0
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
auction_id |
integer | The ID of the auction to retrieve bids for | - | Required |
page |
integer | The page number for pagination |
1
|
Optional |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"id": 181468,
"bid": 2.1,
"owner": {
"id": 9755,
"type": "account"
},
"created_at": "2025-06-04 20:32:55"
},
{
"id": 181351,
"bid": 1.999,
"owner": {
"id": 9802,
"type": "account"
},
"created_at": "2025-06-04 17:52:40"
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
account_id |
integer | The ID of the account to retrieve information for | - | Required |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": {
"id": 1,
"username": "JohnDoe",
"avatar": "https://example.com/avatars/johndoe.png",
"region_id": 1,
"nationality_id": 1,
"total_damage": 321432,
"total_mined_gold": 3424,
"total_builder_progress": 65243,
"day_of_birth": 100
}
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
page |
integer | The page number for pagination |
1
|
Optional |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"id": 1,
"equipment_id": 2,
"is_equipped": true
},
{
"id": 2,
"equipment_id": 2,
"is_equipped": false
}
]
}
Endpoint URL
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"id": 1,
"name": "United States",
"avatar": "https://example.com/avatars/us.png",
"currency": {
"id": 1,
"name": "USD",
"symbol": "https://example.com/avatars/us.png"
},
"is_available": true,
"laws": {
"work_tax": 20,
"vat": 10,
"import_taxes": 5,
"minimum_wage": 15
},
"ideology_share": {
"capitalism": 25,
"nationalism": 15,
"centralism": 10,
"socialism": 20,
"imperialism": 18,
"communism": 12
}
},
{
"id": 2,
"name": "Brazil",
"avatar": "https://example.com/avatars/br.png",
"currency": {
"id": 2,
"name": "BRL",
"symbol": "https://example.com/avatars/br.png"
},
"is_available": true,
"laws": {
"work_tax": 20,
"vat": 10,
"import_taxes": 5,
"minimum_wage": 15
},
"ideology_share": {
"capitalism": 30,
"nationalism": 20,
"centralism": 5,
"socialism": 25,
"imperialism": 10,
"communism": 10
}
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
country_id |
integer | The ID of the country to retrieve regions for | - | Required |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"id": 213,
"name": "Durban",
"type": 3,
"population": 26,
"original_country_id": 37,
"country_id": 13,
"nb_npcs": 3,
"pollution": 23,
"factories": {
"food": 0,
"weapon": 0,
"oil": 0,
"grain": 0,
"iron": 0,
"aircraft": 0,
"titanium": 0,
"tickets": 0
},
"buildings": {
"hospital": {
"id": 1,
"name": "Hospital",
"level": 3
},
"military_base": {
"id": 2,
"name": "Military Base",
"level": 5
}
},
"bonus": [
{
"type": "FOOD",
"value": 15
}
]
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
country_id |
integer | The ID of the country to retrieve currency transactions for | - | Required |
page |
integer | Page number for pagination |
1
|
Optional |
Responses
200 Success - Returns currency transaction logs with associated complex transaction data (items, currencies, stocks) when available. Results are paginated with 25 records per page.
{
"code": 200,
"description": "Success - Returns currency transaction logs with associated complex transaction data (items, currencies, stocks) when available. Results are paginated with 25 records per page.",
"data": [
{
"id": 12345,
"from": {
"id": 1,
"name": "United States",
"type": "country",
"avatar": "https://example.com/avatars/us.png"
},
"to": {
"id": 123,
"name": "John Doe",
"type": "account",
"avatar": "https://example.com/avatars/user123.png"
},
"currency_id": 1,
"value": 1000.5,
"description": "Salary payment",
"created_at": "2024-01-15 10:30:00",
"complex_transactions": []
},
{
"id": 12346,
"from": {
"id": 456,
"name": "Acme Corporation",
"type": "holding",
"avatar": "https://example.com/avatars/holding456.png"
},
"to": {
"id": 1,
"name": "United States",
"type": "country",
"avatar": "https://example.com/avatars/us.png"
},
"currency_id": 1,
"value": 5000,
"description": "Trade: 100 Food for 5000 USD",
"created_at": "2024-01-15 11:45:00",
"complex_transactions": [
{
"id": 789,
"from": {
"id": 1,
"type": "country"
},
"to": {
"id": 456,
"type": "holding"
},
"created_at": "2024-01-15 11:45:00",
"item_logs": [
{
"id": 1001,
"item_id": 1,
"quantity": 100,
"from": {
"id": 1,
"type": "country"
},
"to": {
"id": 456,
"type": "holding"
},
"description": "Trade: 100 Food for 5000 USD",
"created_at": "2024-01-15 11:45:00"
}
],
"currency_logs": [],
"stock_logs": []
}
]
}
],
"pagination": {
"current_page": 1,
"total_pages": 42,
"per_page": 25,
"total_records": 1048
}
}
400 Bad Request
{
"code": 400,
"description": "Bad Request",
"message": "country_id parameter is required"
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
statistic |
string |
The statistic parameter to order countries by
Allowed values:
development
citizens
builders
buildings
miners
todaycitizens
productivity
activecitizens
damagetoday
damage
strength
regions
npcwage
|
- | Required |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"entity": {
"id": 1,
"name": "United States",
"avatar": "https://example.com/avatars/us.png"
},
"value": 1000000
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
event_wars |
integer | Display event wars or normal wars (0 for normal, 1 for event) |
0
|
Optional |
extra_details |
integer | Include extra details in the response (0 for no, 1 for yes) |
0
|
Optional |
expired |
integer | Show expired wars in the response (0 for no, 1 for yes) |
0
|
Optional |
war_id |
integer | The ID of the war to retrieve details for |
0
|
Optional |
page |
integer | The page number for pagination |
1
|
Optional |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"id": 1,
"attackers": {
"id": 1,
"name": "United States",
"avatar": "https://example.com/avatars/us.png"
},
"defenders": {
"id": 2,
"name": "Portugal",
"avatar": "https://example.com/avatars/pt.png"
},
"region": {
"id": 1,
"name": "Lisbon"
},
"attackers_score": 340000,
"defenders_score": 100000,
"current_round_number": 3,
"current_round_id": 325432,
"flags": {
"is_revolution": 0
}
}
]
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
war_id |
integer | The ID of the war to retrieve hits for | - | Required |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"id": 86653,
"end_date": "2025-07-07 05:42:38",
"attackers_score": 0,
"defenders_score": 0,
"attackers_points": 0,
"defenders_points": 0,
"attackers_hero": null,
"defenders_hero": null
},
{
"id": 86654,
"end_date": "2025-07-07 08:22:38",
"attackers_score": 0,
"defenders_score": 0,
"attackers_points": 0,
"defenders_points": 0,
"attackers_hero": null,
"defenders_hero": null
}
]
}
404 Response
{
"code": 404,
"message": "War not found"
}
Endpoint URL
Parameters
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
war_round_id |
integer | The ID of the war round to retrieve hits for | - | Required |
page |
integer | The page number for pagination |
1
|
Optional |
Responses
200 Success
{
"code": 200,
"description": "Success",
"data": [
{
"id": 1,
"fighter": {
"id": 1,
"type": "account"
},
"damage": 1342,
"side": "ATTACKER",
"item_id": null,
"created_at": "2025-07-01 01:00:00"
},
{
"id": 1,
"fighter": {
"id": 1,
"type": "account"
},
"damage": 1252,
"side": "DEFENDER",
"item_id": null,
"created_at": "2025-07-01 00:01:00"
}
]
}