Unofficial Drawshield API docs Built by Flammableassassin
If you wish to contribute feel free to here https://github.com/flamableassassin/openapi-docs/
Checkout other projects I have made around Drawshield:
The open source part of the website on /include Github
The endpoint for producing shields
| blazon required | string (blazon) Example: blazon=Crusilly orange and gules three chevronels interlaced purpure three lions courant in bend sinister or. The blazon to be used |
| shape | string (shape) Default: "heater" Enum: "heater" "heater" "french" "oval" "lozenge" "square" "italian" "swiss" "english" "german" "horsehead" "polish" "spanish" "circle" "sca" "hungarian" "scutum" "african" "persian" "swatch" "pauldron" "stamp" "flag" The shape of the output |
| palette | string (palette) Default: "drawshield" Enum: "wikipedia" "drawshield" "wappenwiki" "cc3" "flat" "english" "emoji" "bajuvarian" "hatching" "outline" The colour palette used |
| effect | string (effect) Default: "none" Enum: "none" "shiny" "plain" "stonework" "plaster" "vellum" "ripples" "fabric" "inked" The effect to apply |
| size | integer (size) Default: 500 The width of the image |
| outputformat | string (outputformat) Default: "svg" Enum: "svg" "jpg" "png" "json" The output format you wish to have |
| ar | number (aspectratio) Default: 0.5 The aspect ratio for the flag shape |
| printable | boolean (printable) Deprecated Default: false This option used to turn off the text shown to the bottom left of the shield when saving as a file. This happens automatically now so the option is no longer required |
| stage | string (stage) Default: "render" Enum: "parser" "references" "links" "render" (For debugging use only) |
| webcols | string (yesParam) Value: "yes" Allow any of the named web colours to be used |
| whcols | string (yesParam) Value: "yes" Allow any of the named web colours to be used |
| tartancols | string (yesParam) Value: "yes" Allow any of the named web colours to be used |
| asfile | string Unknown affect on request If this option is present then instead of returning the image the program will force the download of the image as a file, called "shield.svg", "shield.png" or "shield.jpg" depending on the setting of the "saveformat" option. |
| saveformat | string (outputformat) Default: "svg" Enum: "svg" "jpg" "png" "json" This option selects the file format for the "asfile" option, it takes the same values as "outputformat" above. |
Generate a random blazon depending on the parameters provided
Note not all parameters for charges are documented. Please see the official docs
| tinc-all | string (onOffParam) Enum: "on" "off" (Colour and Pattern) Turn all tinctures on or off (processed first) |
| tinc-common | string (onOffParam) Enum: "on" "off" (Colour and Pattern) Use the most common heraldic colours (Gules, azure...) |
| tinc-second | string (onOffParam) Enum: "on" "off" (Colour and Pattern) Use the secondary heraldic colours (Tenne, murrey...) |
| tinc-modern | string (onOffParam) Enum: "on" "off" (Colour and Pattern) Use modern colours (Copper, iron, buff...) |
| tinc-treatments | string (onOffParam) Enum: "on" "off" (Colour and Pattern) Use any two of the preceding colours in one of a number of repeating patterns (Fretty, maily...) |
| tinc-furs | string (onOffParam) Enum: "on" "off" (Colour and Pattern) Use any of the known furs (Ermine, potent...) |
| div-all | string (onOffParam) Enum: "on" "off" (Division) Turn all divisions on or off (processed first) |
| div-chance | integer (0To100) [ 0 .. 100 ] (Division) %-age likelihood of a divided field (as opposed to a plain field) |
| div-2part | string (onOffParam) Enum: "on" "off" (Division) Use the major two part divisions (per fess, per pale...) |
| div-3part | string (onOffParam) Enum: "on" "off" (Division) Use the major three part divisions (tierced in fess...) |
| div-bars | string (onOffParam) Enum: "on" "off" (Division) Use divisions made up of bars (barry, bendy...) |
| div-small | string (onOffParam) Enum: "on" "off" (Division) Use the smaller, less common divisions (Chape, chausse...) |
| div-pattern | string (onOffParam) Enum: "on" "off" (Division) Use divisions of over-lapping bars (Barry bendy...) |
| div-counter | string (onOffParam) Enum: "on" "off" (Division) Use two overlapping divisions, counterchanged |
| div-edges | string (onOffParam) Enum: "on" "off" (Division) Vary the edge types (wavy, rayonny...) |
| ord-all | string (onOffParam) Enum: "on" "off" (Ordinary) Turn all ordinaries on or off (processed first) |
| ord-chance | integer (0To100) [ 0 .. 100 ] (Ordinary) %-age likelyhood of an ordinary appearing |
| ord-common | string (onOffParam) Enum: "on" "off" (Ordinary) Use common ordinaries (Fess, pale, bend...) |
| ord-multi | string (onOffParam) Enum: "on" "off" (Ordinary) Use ordinaries made of multiple bars (bars, pales...) |
| ord-minor | string (onOffParam) Enum: "on" "off" (Ordinary) Use less common ordinaries (Canton, gyron...) |
| ord-rare | string (onOffParam) Enum: "on" "off" (Ordinary) Use rarely seen ordinaries (Crancelin, gorge...) |
| ord-mods | string (onOffParam) Enum: "on" "off" (Ordinary) Vary edges, add cottices etc. (nowy, voided...) |
| chg-all | string (onOffParam) Enum: "on" "off" (Charges) Turn all charges on or off (processed first) |
| chg-chance | integer (0To100) [ 0 .. 100 ] (Charges) %-age likelyhood of a charge appearing |
| chg-lion | string (onOffParam) Enum: "on" "off" (Charges) Use various poses of lions and their features (lion rampant...) |
| chg-geom | string (onOffParam) Enum: "on" "off" (Charges) Use geometric charges (mullet, triangle...) |
| chg-cross | string (onOffParam) Enum: "on" "off" (Charges) Use some of the many styles of heraldic crosses as charges (tau, bottony...) |
| chg-bird | string (onOffParam) Enum: "on" "off" (Charges) Use charges of various birds, possibly in different poses (chough, dove...) |
| chg-crown | string (onOffParam) Enum: "on" "off" (Charges) Crown's, coronets and jewels (Naval, Ducal, orb...) |
| chg-animal | string (onOffParam) Enum: "on" "off" (Charges) Use charges of animals that do not fall into other categories, possibly in different poses (fox, sheep...) |
| chg-weapon | string (onOffParam) Enum: "on" "off" (Charges) Use charges of weapons and related items (sword, pheon...) |
| chg-myth | string (onOffParam) Enum: "on" "off" (Charges) Use charges of mythical creatures, possibly in different poses (dragon, basilisk...) |
| chg-symbols | string (onOffParam) Enum: "on" "off" (Charges) Use charges that represent various symbols (planet mars, alchemical...) |
| chg-loc-chance | integer (0To100) [ 0 .. 100 ] (Charges) %-age likelyhood that the charge is in a location other than centered on the field |
Gules a fess quadrate argent. // created by Drawshield.net/random
Get the definition of a term
| term required | string |
| source | string Default: "*" Enum: "parker" "elvin" "*" The source dictionary to search. For more information please see the official Docs |
| match | string Default: "fuzzy" Enum: "exact" "fuzzy" How to search the dictionary. For more information please see the official Docs |
{- "content": "Azure, bright blue, i.e. the colour of an eastern sky, probably derives the name from the Arabic lazura(conf. lapis lazuli, Gr. , Span. azul, Italian azurro, Fr. azur), the name being introduced from the East at the time of the Crusades. It is sometimes called Inde from the sapphire, which is found in the East: (see example under cadency.) Heralds who blazon by planets called it Jupiter, perhaps from his supposed rule over the skies; and when the names of jewels are employed it is called Sapphire. Engravers represent it by an indefinite number of horizontal line.",
}Searches the gallery for a query of either the item id or blazon.
Notes:
required | Blazon query (string) or Gallery item id (integer) |
"009704 pale to the sinister to the sinister a lion rampant narrower narrower //azures, lion rampant between four roses or with tags: lion reguardant, roses ar\n008649 celestial azure celestial azure celestial azure celestial azure celestial azure celestial azure celestial azure celestial azure celestial azure celestial\n007889 barry of seven azure, argent, azure, or, azure, argent, and azure achievement mantling azure and argent crest on a helmet iron two ostrich feathers add\n005491 azure, a barrulet tierced per fess azure argent azure, an endorse tierced per pale azure argent azure, in fess point a hurt fimbriated azure smaller, i\n010152 med azure langued azure; 2). or a lion rampant gules armed azure langued azure;; 2nd per pale. 1). or a lion rampant gules armed azure langued azure; 2\n000503 tierced in pale azure, azure and azure a bend indented or a eagle argent (previously entry no. 9497) micro nation\n007107 ure a plate fimbriated azure a hurt fimbriated azure a crosslet azure fimbriated azure a crosslet argent fimbriated azure (previously entry no. 289\n004688 med azure iv gules 3 lion passant guardant in pale or armed azure langued azure v azure a harp or vi argent a maple leaf gules mantling argent and gul\n004873 e smaller, iv gules 3 lion passant guardant in pale or armed azure langued azure, v azure a harp or vi argent a maple leaf gules (previously entry no. \n005160 n pale or armed azure langued azure 2nd or a double tressure flory counter flory gules a lion gules armed azure langued azure 3rd azure a harp or smalle\n009635 d and langued azure in pale 16th or six fleur de lis fancy azure stroked azure arranged 3 2 1 17th or semy of hearts azure a lion azure armed and lang\n005200 blazon tierced in fess embattled sable argent and azure in chief 3 star or in nombril 2 forget me not argent a bear couchant sable (previously entry \n000855 arp or, stringed argent. fourth or a lion rampant gules armed and langued azure within a double tressure flory counter flory gules. (previously entry no\n004105 blazon quartered i and iv argent a crosslet formy gules ii and iii azure a bend or (previously entry no. 5895)\n000259 sinister 4th or a lion rampant sable armed and langued gules impaled with azure semy de crosses crosslet fitchy or two salmon or palewise reversed higher;\n005386 quarterly white, barry or and sable, azure in first quarter a cornucopia yellow ochre in second quarter a wolf rampant white in third quarter a wolf \n001405 blazon quarterly azure and gules one anchor sable one lion or goutty gules armed langued crowned argent on a chief rayonny argent three sea horse gules\n006158 d and to the dexter and to the dexter, a base wavy barry wavy argent and azure, a natural eagle or and and and to the dexter and to the dexter, a light\n002261 blazon gules one flank or semy of stars azure one bow argent (previously entry no. 7739)\n000439 gules 2 lions passant gardant or in pale armed langued azure (previously entry no. 9561)\n010380 argent, on a chevron azure a griffin s head erased or shewn between two mascles of the field, two crosses bottony fitchy in chief and a mullet sable she\n010931 azure a bend chequy argent and gules\n006012 of mortimer (previously entry no. 3988) with tags: england barry or and azure, on a chief of the first two pallets between two gyrons of the second over\n009296 per fess engrailed argent and azure, one annulet of rope orange with tags: annulet, rope, sea\n009068 quartered i and iv azure three fleur de lis or ii and iii white three lions gules with tags: regional it s inspired by the coat of arms of picardy and i\n004467 blazon gyronny of 12 or and azure four seagulls volant in pale ermine created by drawshield.net/random (previously entry no. 5533)\n010952 quarterly, i and iv azure a dove reguardant or, ii paly of seven argent and sable, iii sanguine a lion courant argent a patriarchal cross argent in middl\n006869 celestial azure on a bend steel 2 archer reversed argent in sinister chief a compass star pierced argent (previously entry no. 3131) with tags: arche\n000773 quarterly 1st and 4th azure a chevron or between 3 owls argent 2nd and 3rd argent a lion rampant sable langued gules a chief or (previously entry no. \n006778 azure one bordure or embattled counter embattled three lions or armed gu langued gu crowned gu mantling az and or one knight helmet argent torse az an\n004243 blazon fretty azure argent a chief gules charged with three leopard heads or langued vert (previously entry no. 5757) with tags: cann\n"Returns a random challenge image for the user to try recreate.
Source parameter info:
Notes:
| source required | string Default: "all" Enum: "coadb" "wikimedia" "public" "all" |
