Documentation for satyr.io

Do you miss any feature or do you think we have a bug in our API? Contact us.

URL format and the right order of parameters

http://satyr.io1/200x3002/red3?text=hello+world4&delay=3g5

Dimensions (required)

Image resolution is required and is always placed as the first parameter in URI path.
Minimal width and height is 1px and maximal width and height is 6000px.

Exact dimension

Square

http://satyr.io/60

Both width and height is 60px.

Rectangle

http://satyr.io/80x60

Width is 80px and height is 60px.

Variable dimension

All images with the same URL are downloaded only once (one request for all images). To download different images with the same variable parameters (same URL), add a special parameter to distinguish these URL's. Eg.:

http://satyr.io/50-80?1
http://satyr.io/50-80?2
http://satyr.io/50-80?3

Square

http://satyr.io/50-80

Width and height have a random value in range from 50px to 80px. Both width and height have the same value.

Rectangle with variable width

http://satyr.io/60-80x60

Width has a random value from 60px to 80px and height is 60px.

Rectangle with variable height

http://satyr.io/80x30-60

Width is 80px and height has a random value from 30px to 60px.

Variable width and height

http://satyr.io/60-80x30-60

Width has a random value in the range from 60px to 80px. Height has a random value in the range from 30px to 60px.

Aspect ratio

Exact width

http://satyr.io/80x16:9

Height is counted from the width of 80px to have the image in the aspect ratio 16:9. So the height will be 45px.

Exact height

http://satyr.io/4:3x60

Width is counted from the height of 60px to have the image in the aspect ratio 4:3. So the width will be 80px.

Query params

http://satyr.io/?width=80&height=60

Both the width and height is possible to write as query params. Query params always have a higher priority than dimensions written with "x".

Background

Background color is optional and is always placed as a second parameter in the URI path.
Default background color is #d6d6d6. Text color is always counted automatically.

Color name

http://satyr.io/80x60/pink

A CSS Level 3 color, sometimes called a SVG or X11 color. List of possible background colors.

RGB

HEX 6-digit

http://satyr.io/80x60/c0ffee

HEX 3-digit

http://satyr.io/80x60/b52

Represents color #bb5522

RGBA

HEX 8-digit

http://satyr.io/80x60/cdef3456

Add alpha channel to RGB color in format #RRGGBBAA.
Examples:

  • FF = 100% - fully opaque
  • 80 = 50.2% - semi transparent
  • 00 = 0% - fully transparent

HEX 4-digit

http://satyr.io/80x60/acdc

Represents color #aaccddcc

Theme

Predefined image style with a different background color and a number in the center of the image. Resolution info is moved to the bottom right corner. You can choose from 99 themes.

Theme 1

http://satyr.io/80x60/1

Theme 2

http://satyr.io/80x60/2

Theme 99

http://satyr.io/80x60/99

Text

Text

http://satyr.io/105x60?text=hello+world

Text can be defined only as a query parameter. Plus sign will be replaced with space.

Delay

Minimal delay is 1 milisecond and maximal is 60,000 miliseconds.

Delay

http://satyr.io/80x60?delay=3000

Delay 3 seconds (3000 miliseconds)

Variable delay

http://satyr.io/80x60?delay=3000-6000

Random delay from 3 to 6 seconds (from 3000 to 6000 miliseconds)

Delay preset

http://satyr.io/80x60?delay=3g

You can choose from several presets based on real connectivity. These presets have a variable delay.

keyworddelay in miliseconds
DSL250 - 150
3G500 - 3000
EDGE1000 - 6000
GPRS2000 - 12000

Flags

Country codes are ISO 3166-1 alpha-3 or ISO 3166-1 alpha-2.
In case of enabled offline mode with Chrome extension, text fallback is applied.

Supported flags

afg (af)ala (ax)alb (al)dza (dz)asm (as)and (ad)ago (ao)aia (ai)ata (aq)atg (ag)arg (ar)arm (am)abw (aw)aus (au)aut (at)aze (az)bhs (bs)bhr (bh)bgd (bd)brb (bb)blr (by)bel (be)blz (bz)ben (bj)bmu (bm)btn (bt)bol (bo)bih (ba)bwa (bw)bra (br)vgb (vg)iot (io)brn (bn)bgr (bg)bfa (bf)bdi (bi)khm (kh)cmr (cm)can (ca)cpv (cv)caf (cf)tcd (td)chl (cl)chn (cn)col (co)com (km)cog (cg)cod (cd)cri (cr)civ (ci)hrv (hr)cub (cu)cyp (cy)cze (cz)dnk (dk)dji (dj)dma (dm)dom (do)ecu (ec)egy (eg)slv (sv)gnq (gq)eri (er)est (ee)eth (et)fji (fj)fin (fi)fra (fr)gab (ga)gmb (gm)geo (ge)deu (de)gha (gh)grc (gr)grd (gd)gtm (gt)gin (gn)gnb (gw)guy (gy)hti (ht)hnd (hn)hun (hu)isl (is)ind (in)idn (id)irn (ir)irq (iq)irl (ie)isr (il)ita (it)jam (jm)jpn (jp)jor (jo)kaz (kz)ken (ke)kir (ki)prk (kp)kor (kr)kwt (kw)kgz (kg)lao (la)lva (lv)lbn (lb)lso (ls)lbr (lr)lby (ly)lie (li)ltu (lt)lux (lu)mkd (mk)mdg (mg)mwi (mw)mys (my)mdv (mv)mli (ml)mlt (mt)mhl (mh)mrt (mr)mus (mu)mex (mx)mda (md)mco (mc)mng (mn)mne (me)mar (ma)moz (mz)mmr (mm)nam (na)nru (nr)npl (np)nld (nl)nzl (nz)nic (ni)ner (ne)nga (ng)nor (no)omn (om)pak (pk)plw (pw)pse (ps)pan (pa)png (pg)pry (py)per (pe)phl (ph)pol (pl)prt (pt)qat (qa)rou (ro)rus (ru)rwa (rw)kna (kn)lca (lc)vct (vc)wsm (ws)smr (sm)sau (sa)sen (sn)srb (rs)syc (sc)sle (sl)sgp (sg)svk (sk)svn (si)slb (sb)som (so)zaf (za)ssd (ss)esp (es)lka (lk)sdn (sd)sur (sr)swz (sz)swe (se)che (ch)syr (sy)tjk (tj)tza (tz)tha (th)tls (tl)tgo (tg)ton (to)tto (tt)tun (tn)tur (tr)tkm (tm)tuv (tv)twn (tw)uga (ug)ukr (ua)are (ae)gbr (gb)usa (us)ury (uy)uzb (uz)vut (vu)ven (ve)vnm (vn)yem (ye)zmb (zm)zwe (zw)

Czechia

http://satyr.io/80x60?flag=cze

Flag image fits the dimensions with a transparent background.

Slovakia

http://satyr.io/80x60?flag=svk

Switzerland

http://satyr.io/80x60?flag=che

Brands

Brand logos are used from simpleicons.org. Icon color is taken from background or theme color.
In case of enabled offline mode with Chrome extension, text fallback is applied.

Supported brands

500pxaboutmeairairbnbamazonamericanexpressandroidappleappnetautomaticbandcampbasecampbathasubebobehancebigcartelbingbitbucketbitcoinbitlybootstrapbuzzfeedcampaignmonitorcirclecicodecademycodepencoderwallcodeschoolcodioconektacourseradailymotiondeezerdeliciousdesignernewsdeviantartdiasporadiggdigitaloceandisqusdribbbledropboxdrupalelloemailempirekredetsyeventbriteeventstoreevernotefacebookfeedlyfitbitflickrflipboardfoursquaregeeklistgeocachingghostgitgithubglassdoorgoldenlinegooglegoogleanalyticsgoogledrivegoogleplaygoogleplusgovukgratipaygravatargulpherokuhouzzhtml5huluimdbinstagraminvisionjavascriptjekylljoomlajsonjustgivingkagglekhanacademykickstarterkikkirbykloutkodinglanyrdlaravellastfmlaunchpadlinelinkedinlivejournalmacysmagentomakerbotmastercardmatternetmediatemplemediummeetupmessengermicrogeneticsminutemailermixcloudmonkeytiemoomyspacenetflixodnoklassnikionedriveoperaovercastpatreonperiscopepinguppinterestplayermepocketpodcastsprotoioquorardioreadabilityreadthedocsredditreverbnationrsssasssaucelabsshopifysimpleiconssinaweibositepointskypeslacksmashingmagazinesongkicksoundcloudspeakerdeckspotifyspreakersquarespacestackoverflowstatamicstitcherstorifystripestubhubstumbleuponswarmtedteslatindertopcodertrakttraviscitreehousetrellotripadvisortruliatumblrtwiliotwitchtwittertwooubuntuudacityviadeovimeovinevirbvisavkwechatwhatsappwikipediawindowswixwordpressxboxxeroxingyahooyammeryelpyoutubezapierzillow

Facebook

http://satyr.io/80x60?brand=facebook

Brand image fits the dimensions with a transparent background.

Apple

http://satyr.io/80x60/purple?brand=apple

Brand color is taken from background color.

Github

http://satyr.io/80x60/6?brand=github

Brand color is taken from theme color.

Type

Supported file types are PNG, JPEG, GIF and WebP. Default is PNG.
In case of enabled offline mode with Chrome extension, supported file types are PNG, JPEG and WebP. Default is PNG. GIF is transformed to WebP.

WebP

http://satyr.io/80x60?type=webp

JPEG

http://satyr.io/80x60?type=jpg

Supported format is also jpeg.

GIF

http://satyr.io/80x60?type=gif

PNG

http://satyr.io/80x60?type=png

You can omit the type in case of PNG.

Texture

Supported textures are cross and graphpaper.

Cross

http://satyr.io/80x60?texture=cross

Graphpaper

http://satyr.io/240x150?texture=graphpaper

The size of one square is 50px.

SSL

https protocol is also supported.

SSL

https://satyr.io/80x60