curl --request POST \
--url https://api.iotools.cloud/v1/tool/readme-badge-generator \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"badgeTemplate": "custom",
"badgeLabel": "build",
"badgeMessage": "passing",
"labelColor": "#555555",
"messageColorPreset": "#4c1",
"messageColor": "#4c1",
"badgeStyle": "flat"
}
'{
"tool": "readme-badge-generator",
"tool_version": "1.0.1",
"outputs": {
"badgeUrl": "data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%2288%22%20height%3D%2220%22%20role%3D%22img%22%20aria-label%3D%22build%3A%20passing%22%3E%3Ctitle%3Ebuild%3A%20passing%3C%2Ftitle%3E%3Cfilter%20id%3D%22blur%22%3E%3CfeGaussianBlur%20stdDeviation%3D%2216%22%2F%3E%3C%2Ffilter%3E%3ClinearGradient%20id%3D%22s%22%20x2%3D%220%22%20y2%3D%22100%25%22%3E%3Cstop%20offset%3D%220%22%20stop-color%3D%22%23bbb%22%20stop-opacity%3D%22.1%22%2F%3E%3Cstop%20offset%3D%221%22%20stop-opacity%3D%22.1%22%2F%3E%3C%2FlinearGradient%3E%3CclipPath%20id%3D%22r%22%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20rx%3D%223%22%2F%3E%3C%2FclipPath%3E%3Cg%20clip-path%3D%22url(%23r)%22%3E%3Crect%20width%3D%2237%22%20height%3D%2220%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2237%22%20width%3D%2251%22%20height%3D%2220%22%20fill%3D%22%234c1%22%2F%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20fill%3D%22url(%23s)%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22110%22%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22195%22%20y%3D%22140%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22615%22%20y%3D%22140%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fg%3E%3C%2Fsvg%3E",
"badgeMarkdown": "%22%3E%3Crect%20width%3D%2237%22%20height%3D%2220%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2237%22%20width%3D%2251%22%20height%3D%2220%22%20fill%3D%22%234c1%22%2F%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20fill%3D%22url(%23s)%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22110%22%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22195%22%20y%3D%22140%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22615%22%20y%3D%22140%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fg%3E%3C%2Fsvg%3E)",
"badgeHtml": "<img src=\"data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%2288%22%20height%3D%2220%22%20role%3D%22img%22%20aria-label%3D%22build%3A%20passing%22%3E%3Ctitle%3Ebuild%3A%20passing%3C%2Ftitle%3E%3Cfilter%20id%3D%22blur%22%3E%3CfeGaussianBlur%20stdDeviation%3D%2216%22%2F%3E%3C%2Ffilter%3E%3ClinearGradient%20id%3D%22s%22%20x2%3D%220%22%20y2%3D%22100%25%22%3E%3Cstop%20offset%3D%220%22%20stop-color%3D%22%23bbb%22%20stop-opacity%3D%22.1%22%2F%3E%3Cstop%20offset%3D%221%22%20stop-opacity%3D%22.1%22%2F%3E%3C%2FlinearGradient%3E%3CclipPath%20id%3D%22r%22%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20rx%3D%223%22%2F%3E%3C%2FclipPath%3E%3Cg%20clip-path%3D%22url(%23r)%22%3E%3Crect%20width%3D%2237%22%20height%3D%2220%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2237%22%20width%3D%2251%22%20height%3D%2220%22%20fill%3D%22%234c1%22%2F%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20fill%3D%22url(%23s)%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22110%22%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22195%22%20y%3D%22140%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22615%22%20y%3D%22140%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fg%3E%3C%2Fsvg%3E\" alt=\"build: passing\">",
"badgeSvg": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"88\" height=\"20\" role=\"img\" aria-label=\"build: passing\"><title>build: passing</title><filter id=\"blur\"><feGaussianBlur stdDeviation=\"16\"/></filter><linearGradient id=\"s\" x2=\"0\" y2=\"100%\"><stop offset=\"0\" stop-color=\"#bbb\" stop-opacity=\".1\"/><stop offset=\"1\" stop-opacity=\".1\"/></linearGradient><clipPath id=\"r\"><rect width=\"88\" height=\"20\" rx=\"3\"/></clipPath><g clip-path=\"url(#r)\"><rect width=\"37\" height=\"20\" fill=\"#555555\"/><rect x=\"37\" width=\"51\" height=\"20\" fill=\"#4c1\"/><rect width=\"88\" height=\"20\" fill=\"url(#s)\"/></g><g fill=\"#fff\" text-anchor=\"middle\" font-family=\"Verdana,Geneva,DejaVu Sans,sans-serif\" text-rendering=\"geometricPrecision\" font-size=\"110\"><g transform=\"scale(.1)\"><g aria-hidden=\"true\" fill=\"#010101\"><text x=\"195\" y=\"150\" fill-opacity=\".8\" filter=\"url(#blur)\" textLength=\"270\">build</text><text x=\"195\" y=\"150\" fill-opacity=\".3\" textLength=\"270\">build</text></g><text x=\"195\" y=\"140\" textLength=\"270\">build</text></g><g transform=\"scale(.1)\"><g aria-hidden=\"true\" fill=\"#010101\"><text x=\"615\" y=\"150\" fill-opacity=\".8\" filter=\"url(#blur)\" textLength=\"410\">passing</text><text x=\"615\" y=\"150\" fill-opacity=\".3\" textLength=\"410\">passing</text></g><text x=\"615\" y=\"140\" textLength=\"410\">passing</text></g></g></svg>"
},
"credits_used": 3,
"credits_remaining": null
}Generators
README Badge Generator
Generate shields.io-style SVG badges for GitHub READMEs — pick a preset (version, license, build, coverage…) or fully customize the label, message, colors and style, and get SVG, Markdown, HTML and a data-URL to copy.
POST
/
v1
/
tool
/
readme-badge-generator
curl --request POST \
--url https://api.iotools.cloud/v1/tool/readme-badge-generator \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"badgeTemplate": "custom",
"badgeLabel": "build",
"badgeMessage": "passing",
"labelColor": "#555555",
"messageColorPreset": "#4c1",
"messageColor": "#4c1",
"badgeStyle": "flat"
}
'{
"tool": "readme-badge-generator",
"tool_version": "1.0.1",
"outputs": {
"badgeUrl": "data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%2288%22%20height%3D%2220%22%20role%3D%22img%22%20aria-label%3D%22build%3A%20passing%22%3E%3Ctitle%3Ebuild%3A%20passing%3C%2Ftitle%3E%3Cfilter%20id%3D%22blur%22%3E%3CfeGaussianBlur%20stdDeviation%3D%2216%22%2F%3E%3C%2Ffilter%3E%3ClinearGradient%20id%3D%22s%22%20x2%3D%220%22%20y2%3D%22100%25%22%3E%3Cstop%20offset%3D%220%22%20stop-color%3D%22%23bbb%22%20stop-opacity%3D%22.1%22%2F%3E%3Cstop%20offset%3D%221%22%20stop-opacity%3D%22.1%22%2F%3E%3C%2FlinearGradient%3E%3CclipPath%20id%3D%22r%22%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20rx%3D%223%22%2F%3E%3C%2FclipPath%3E%3Cg%20clip-path%3D%22url(%23r)%22%3E%3Crect%20width%3D%2237%22%20height%3D%2220%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2237%22%20width%3D%2251%22%20height%3D%2220%22%20fill%3D%22%234c1%22%2F%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20fill%3D%22url(%23s)%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22110%22%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22195%22%20y%3D%22140%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22615%22%20y%3D%22140%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fg%3E%3C%2Fsvg%3E",
"badgeMarkdown": "%22%3E%3Crect%20width%3D%2237%22%20height%3D%2220%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2237%22%20width%3D%2251%22%20height%3D%2220%22%20fill%3D%22%234c1%22%2F%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20fill%3D%22url(%23s)%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22110%22%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22195%22%20y%3D%22140%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22615%22%20y%3D%22140%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fg%3E%3C%2Fsvg%3E)",
"badgeHtml": "<img src=\"data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%2288%22%20height%3D%2220%22%20role%3D%22img%22%20aria-label%3D%22build%3A%20passing%22%3E%3Ctitle%3Ebuild%3A%20passing%3C%2Ftitle%3E%3Cfilter%20id%3D%22blur%22%3E%3CfeGaussianBlur%20stdDeviation%3D%2216%22%2F%3E%3C%2Ffilter%3E%3ClinearGradient%20id%3D%22s%22%20x2%3D%220%22%20y2%3D%22100%25%22%3E%3Cstop%20offset%3D%220%22%20stop-color%3D%22%23bbb%22%20stop-opacity%3D%22.1%22%2F%3E%3Cstop%20offset%3D%221%22%20stop-opacity%3D%22.1%22%2F%3E%3C%2FlinearGradient%3E%3CclipPath%20id%3D%22r%22%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20rx%3D%223%22%2F%3E%3C%2FclipPath%3E%3Cg%20clip-path%3D%22url(%23r)%22%3E%3Crect%20width%3D%2237%22%20height%3D%2220%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2237%22%20width%3D%2251%22%20height%3D%2220%22%20fill%3D%22%234c1%22%2F%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20fill%3D%22url(%23s)%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22110%22%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22195%22%20y%3D%22140%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22615%22%20y%3D%22140%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fg%3E%3C%2Fsvg%3E\" alt=\"build: passing\">",
"badgeSvg": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"88\" height=\"20\" role=\"img\" aria-label=\"build: passing\"><title>build: passing</title><filter id=\"blur\"><feGaussianBlur stdDeviation=\"16\"/></filter><linearGradient id=\"s\" x2=\"0\" y2=\"100%\"><stop offset=\"0\" stop-color=\"#bbb\" stop-opacity=\".1\"/><stop offset=\"1\" stop-opacity=\".1\"/></linearGradient><clipPath id=\"r\"><rect width=\"88\" height=\"20\" rx=\"3\"/></clipPath><g clip-path=\"url(#r)\"><rect width=\"37\" height=\"20\" fill=\"#555555\"/><rect x=\"37\" width=\"51\" height=\"20\" fill=\"#4c1\"/><rect width=\"88\" height=\"20\" fill=\"url(#s)\"/></g><g fill=\"#fff\" text-anchor=\"middle\" font-family=\"Verdana,Geneva,DejaVu Sans,sans-serif\" text-rendering=\"geometricPrecision\" font-size=\"110\"><g transform=\"scale(.1)\"><g aria-hidden=\"true\" fill=\"#010101\"><text x=\"195\" y=\"150\" fill-opacity=\".8\" filter=\"url(#blur)\" textLength=\"270\">build</text><text x=\"195\" y=\"150\" fill-opacity=\".3\" textLength=\"270\">build</text></g><text x=\"195\" y=\"140\" textLength=\"270\">build</text></g><g transform=\"scale(.1)\"><g aria-hidden=\"true\" fill=\"#010101\"><text x=\"615\" y=\"150\" fill-opacity=\".8\" filter=\"url(#blur)\" textLength=\"410\">passing</text><text x=\"615\" y=\"150\" fill-opacity=\".3\" textLength=\"410\">passing</text></g><text x=\"615\" y=\"140\" textLength=\"410\">passing</text></g></g></svg>"
},
"credits_used": 3,
"credits_remaining": null
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Preset
Available options:
custom, version, license, build, coverage, downloads, stars, love Label
Message
Label Color
Message Color
Available options:
#4c1, #97ca00, #a4a61d, #dfb317, #fe7d37, #e05d44, #007ec6, #9f9f9f, #464aff, custom Custom Color
Style
Available options:
flat, flat-square, for-the-badge, plastic Response
Tool output
Show child attributes
Show child attributes
The tool's slug, echoing the {slug} in the request path.
Output-contract version for this tool.
Credits this call consumed, after any settlement refund. 0 when metering is disabled.
Credits left in the current monthly allowance, or null when metering is disabled.
Correlation id, also sent as x-request-id.
Was this page helpful?
⌘I