AoS API (Unofficial) (1.0.0)

Download OpenAPI specification:Download

API specification for an AoS REST API (Unofficial)

allegiances

Get all allegiances

query Parameters

limit	integer number of allegiances to return
offset	integer number of allegiances to skip
name	string name of allegiance to filter by
grand_alliance	string id of grand alliance to filter by

Responses

Response samples

200
404

Content type

application/json

[{"_id": "string",
"name": "string",
"description": "string",
"grand_alliance": "string",
"mortal_realm": "string"
}
]

Get allegiance by id

path Parameters

id

required

string

id of allegiance to return

Responses

Response samples

200
404

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string",
"grand_alliance": "string",
"mortal_realm": "string"
}

armies

Get all armies

Responses

Response samples

200
404

Content type

application/json

[{"_id": "string",
"name": "string",
"units": [{"_id": "string",
"name": "string",
"allegiance": "string",
"grand_alliance": "string",
"champion": "string",
"size": "string",
"move": "string",
"description": "string",
"save": 0,
"bravery": 0,
"models": 0,
"points": 0,
"wounds": 0,
"abilities": [{"name": "string",
"description": "string"
}
],
"keywords": ["string"
],
"command_abilities": [{"name": "string",
"description": "string"
}
],
"magic": [{"name": "string",
"description": "string"
}
],
"damage_table": [{"_id": "string",
"wound_track_position": 0,
"move": "string",
"min_wounds_suffered": 0
}
],
"missile_weapons": [{"_id": "string",
"name": "Lance and Sword",
"range": "string",
"attacks": "string",
"to_hit": "string",
"to_wound": "string",
"rend": "string",
"damage": "string"
}
],
"melee_weapons": [{"_id": "string",
"name": "Lance and Sword",
"range": "string",
"attacks": "string",
"to_hit": "string",
"to_wound": "string",
"rend": "string",
"damage": "string"
}
]
}
]
}
]

Get army by id

path Parameters

id

required

string

id of army to return

Responses

Response samples

200
404

Content type

application/json

{"_id": "string",
"name": "string",
"units": [{"_id": "string",
"name": "string",
"allegiance": "string",
"grand_alliance": "string",
"champion": "string",
"size": "string",
"move": "string",
"description": "string",
"save": 0,
"bravery": 0,
"models": 0,
"points": 0,
"wounds": 0,
"abilities": [{"name": "string",
"description": "string"
}
],
"keywords": ["string"
],
"command_abilities": [{"name": "string",
"description": "string"
}
],
"magic": [{"name": "string",
"description": "string"
}
],
"damage_table": [{"_id": "string",
"wound_track_position": 0,
"move": "string",
"min_wounds_suffered": 0
}
],
"missile_weapons": [{"_id": "string",
"name": "Lance and Sword",
"range": "string",
"attacks": "string",
"to_hit": "string",
"to_wound": "string",
"rend": "string",
"damage": "string"
}
],
"melee_weapons": [{"_id": "string",
"name": "Lance and Sword",
"range": "string",
"attacks": "string",
"to_hit": "string",
"to_wound": "string",
"rend": "string",
"damage": "string"
}
]
}
]
}

cities

Get all cities

query Parameters

limit	integer number of cities to return
offset	integer number of cities to skip
name	string name of city to filter by

Responses

Response samples

200
404

Content type

application/json

[{"_id": "string",
"name": "string",
"description": "string"
}
]

Get city by id

path Parameters

id

required

string

id of city to return

Responses

Response samples

200
404

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string"
}

docs

Get API documentation

Responses

Response samples

404

Content type

application/json

{"code": 404,
"message": "Not Found"
}

grand-alliances

Get all grand alliances

Responses

Response samples

200
404

Content type

application/json

[{"_id": "string",
"name": "string",
"description": "string"
}
]

Get grand alliance by id

path Parameters

id

required

string

id of grand alliance to return

Responses

Response samples

200
404

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string"
}

grand-strategies

Get all grand strategies

Responses

Response samples

200
404

Content type

application/json

[{"_id": "string",
"name": "string",
"description": "string"
}
]

Get grand strategy by id

path Parameters

id

required

string

id of grand strategy to return

Responses

Response samples

200
404

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string"
}

health

Get health status

Responses

Response samples

200
404

Content type

application/json

{"status": "string"
}

units

Get all units

query Parameters

limit	integer number of units to return
offset	integer number of units to skip
name	string name of unit to filter by
allegiance	string allegiance of unit to filter by
grand_alliance	string grand alliance of unit to filter by
grand_strategy	string grand strategy of unit to filter by
points	integer points of unit to filter by

Responses

Response samples

200
404

Content type

application/json

[{"_id": "string",
"name": "string",
"allegiance": "string",
"grand_alliance": "string",
"champion": "string",
"size": "string",
"move": "string",
"description": "string",
"save": 0,
"bravery": 0,
"models": 0,
"points": 0,
"wounds": 0,
"abilities": [{"name": "string",
"description": "string"
}
],
"keywords": ["string"
],
"command_abilities": [{"name": "string",
"description": "string"
}
],
"magic": [{"name": "string",
"description": "string"
}
],
"damage_table": [{"_id": "string",
"wound_track_position": 0,
"move": "string",
"min_wounds_suffered": 0
}
],
"missile_weapons": [{"_id": "string",
"name": "Lance and Sword",
"range": "string",
"attacks": "string",
"to_hit": "string",
"to_wound": "string",
"rend": "string",
"damage": "string"
}
],
"melee_weapons": [{"_id": "string",
"name": "Lance and Sword",
"range": "string",
"attacks": "string",
"to_hit": "string",
"to_wound": "string",
"rend": "string",
"damage": "string"
}
]
}
]

Get unit by id

path Parameters

id

required

string

id of unit to return

Responses

Response samples

200
404

Content type

application/json

{"_id": "string",
"name": "string",
"allegiance": "string",
"grand_alliance": "string",
"champion": "string",
"size": "string",
"move": "string",
"description": "string",
"save": 0,
"bravery": 0,
"models": 0,
"points": 0,
"wounds": 0,
"abilities": [{"name": "string",
"description": "string"
}
],
"keywords": ["string"
],
"command_abilities": [{"name": "string",
"description": "string"
}
],
"magic": [{"name": "string",
"description": "string"
}
],
"damage_table": [{"_id": "string",
"wound_track_position": 0,
"move": "string",
"min_wounds_suffered": 0
}
],
"missile_weapons": [{"_id": "string",
"name": "Lance and Sword",
"range": "string",
"attacks": "string",
"to_hit": "string",
"to_wound": "string",
"rend": "string",
"damage": "string"
}
],
"melee_weapons": [{"_id": "string",
"name": "Lance and Sword",
"range": "string",
"attacks": "string",
"to_hit": "string",
"to_wound": "string",
"rend": "string",
"damage": "string"
}
]
}

Get weapons for unit by id

path Parameters

id

required

string

id of unit to return weapons for

Responses

Response samples

200
404

Content type

application/json

{"melee_weapons": [{"_id": "string",
"name": "Lance and Sword",
"range": "string",
"attacks": "string",
"to_hit": "string",
"to_wound": "string",
"rend": "string",
"damage": "string"
}
],
"missile_weapons": [{"_id": "string",
"name": "Lance and Sword",
"range": "string",
"attacks": "string",
"to_hit": "string",
"to_wound": "string",
"rend": "string",
"damage": "string"
}
]
}

Get abilities for unit by id

path Parameters

id

required

string

id of unit to return abilities for

Responses

Response samples

200
404

Content type

application/json

[{"name": "string",
"description": "string"
}
]

warscrolls

Get all warscrolls

query Parameters

limit	integer number of warscrolls to return
offset	integer number of warscrolls to skip
name	string name of warscroll to filter by
points	integer points of warscroll to filter by
battlefield_role	string battlefield_role of warscroll to filter by
size	string size of warscroll to filter by
notes	string notes of warscroll to filter by

Responses

Response samples

200
404

Content type

application/json

[{"_id": "string",
"name": "string",
"allegiance_id": "string",
"allegiance": {"_id": "string",
"name": "string",
"description": "string",
"grand_alliance": "string",
"mortal_realm": "string"
},
"grand_alliance_id": "string",
"grand_alliance": {"_id": "string",
"name": "string",
"description": "string"
},
"size": 0,
"points": 0,
"battlefield_role": "string",
"notes": "string"
}
]

Get warscroll by id

path Parameters

id

required

string

id of warscroll to return

Responses

Response samples

200
404

Content type

application/json

{"_id": "string",
"name": "string",
"allegiance_id": "string",
"allegiance": {"_id": "string",
"name": "string",
"description": "string",
"grand_alliance": "string",
"mortal_realm": "string"
},
"grand_alliance_id": "string",
"grand_alliance": {"_id": "string",
"name": "string",
"description": "string"
},
"size": 0,
"points": 0,
"battlefield_role": "string",
"notes": "string"
}