Images
Some API calls will return image objects for things such as logos or photos. The url field of the image object contains the url where you will find that image. This url is for the 'default' version of the image. There are some query string parameters available to change how the image is returned.
format
By default the image is returned in whatever format it was uploaded in, but by specifying the 'format' parameter you can change this. Valid options are: png, jpg, webp.
size
By default the image is returned as a square of 100x100 pixels. By specifying the 'size' parameter the image will be returned at a difference size. The available options are
100
100x100
200
200x200
400
400x400
800
800x800
1000
1000x1000
RAW
The original dimensions that the image was uploaded with
Images will not be scaled up. If you ask for an image with size=400, but the image is only 200x200 then the image will be returned as 200x200.
All images returned (apart from size=RAW) are square. If the original image that is uploaded is not square, then it is padded with a transparent (white for jpg) background.
An example url is: https://img.dc.atriumsports.com/586aa6b195d243c4ae4154c8a61eda19?size=200&format=webp
Last updated
Was this helpful?