Avatars API Reference - Docs

The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.

The Avatars service allows you to fetch country flags, browser icons, payment methods logos, remote websites favicons, generate QR codes, and manipulate remote image URLs.

All endpoints in this service allow you to resize, crop, and change the output image quality for maximum performance and visibility in your app.

Base URL

https://cloud.appwrite.io/v1

Get Browser Icon

You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user GET /account/sessions endpoint. Use width, height and quality arguments to change the output settings.

When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.

Request
- code string
  required
  
  Browser Code.
- width integer
  
  Image width. Pass an integer between 0 to 2000. Defaults to 100.
- height integer
  
  Image height. Pass an integer between 0 to 2000. Defaults to 100.
- quality integer
  
  Image quality. Pass an integer between 0 to 100. Defaults to 100.
Response
- 200 application/json

Endpoint

GET /avatars/browsers/{code}

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Avatars;

Client client = new Client()
    .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("5df5acd0d48c2") // Your project ID
    .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key

Avatars avatars = new Avatars(client);

avatars.getBrowser(
    "aa",
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

Get Credit Card Icon

The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.

When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.

Request
- code string
  required
  
  Credit Card Code. Possible values: amex, argencard, cabal, censosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.
- width integer
  
  Image width. Pass an integer between 0 to 2000. Defaults to 100.
- height integer
  
  Image height. Pass an integer between 0 to 2000. Defaults to 100.
- quality integer
  
  Image quality. Pass an integer between 0 to 100. Defaults to 100.
Response
- 200 application/json

Endpoint

GET /avatars/credit-cards/{code}

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Avatars;

Client client = new Client()
    .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("5df5acd0d48c2") // Your project ID
    .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key

Avatars avatars = new Avatars(client);

avatars.getCreditCard(
    "amex",
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

Get Favicon

Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.

Request
- url string
  required
  
  Website URL which you want to fetch the favicon from.
Response
- 200 application/json

Endpoint

GET /avatars/favicon

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Avatars;

Client client = new Client()
    .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("5df5acd0d48c2") // Your project ID
    .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key

Avatars avatars = new Avatars(client);

avatars.getFavicon(
    "https://example.com"
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

Get Country Flag

You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the ISO 3166-1 standard.

When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.

Request
- code string
  required
  
  Country Code. ISO Alpha-2 country code format.
- width integer
  
  Image width. Pass an integer between 0 to 2000. Defaults to 100.
- height integer
  
  Image height. Pass an integer between 0 to 2000. Defaults to 100.
- quality integer
  
  Image quality. Pass an integer between 0 to 100. Defaults to 100.
Response
- 200 application/json

Endpoint

GET /avatars/flags/{code}

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Avatars;

Client client = new Client()
    .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("5df5acd0d48c2") // Your project ID
    .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key

Avatars avatars = new Avatars(client);

avatars.getFlag(
    "af",
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

Get Image from URL

Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.

When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.

Request
- url string
  required
  
  Image URL which you want to crop.
- width integer
  
  Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
- height integer
  
  Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
Response
- 200 application/json

Endpoint

GET /avatars/image

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Avatars;

Client client = new Client()
    .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("5df5acd0d48c2") // Your project ID
    .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key

Avatars avatars = new Avatars(client);

avatars.getImage(
    "https://example.com",
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

Get User Initials

Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.

You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.

When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.

Request
- name string
  
  Full Name. When empty, current user name or email will be used. Max length: 128 chars.
- width integer
  
  Image width. Pass an integer between 0 to 2000. Defaults to 100.
- height integer
  
  Image height. Pass an integer between 0 to 2000. Defaults to 100.
- background string
  
  Changes background color. By default a random color will be picked and stay will persistent to the given name.
Response
- 200 application/json

Endpoint

GET /avatars/initials

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Avatars;

Client client = new Client()
    .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("5df5acd0d48c2") // Your project ID
    .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key

Avatars avatars = new Avatars(client);

avatars.getInitials(
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

Get QR Code

Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.

Request
- text string
  required
  
  Plain text to be converted to QR code image.
- size integer
  
  QR code size. Pass an integer between 1 to 1000. Defaults to 400.
- margin integer
  
  Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
- download boolean
  
  Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
Response
- 200 application/json

Endpoint

GET /avatars/qr

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Avatars;

Client client = new Client()
    .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("5df5acd0d48c2") // Your project ID
    .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key

Avatars avatars = new Avatars(client);

avatars.getQR(
    "[TEXT]",
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

Recommended