Docs

Avatars

The avatars service aims to help you complete everyday tasks related to your app images, icons, and avatars. Using this service, we hope to save you some precious time and help you focus on solving your real app challenges.

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

All endpoints in this service allow you to resize, crop, and change the output image quality to best fit in your app both in terms of look and performance.

Get Credit Card Icon

GET/avatars/credit-cards/{code}

Need to display your users with your billing method or their payment methods? 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.

Arguments

Name Type Description
code required string

Credit Card Code. Possible values: amex, argencard, cabal, censosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa.

width optional integer

Image width. Pass an integer between 0 to 2000. Defaults to 100

height optional integer

Image height. Pass an integer between 0 to 2000. Defaults to 100

quality optional integer

Image quality. Pass an integer between 0 to 100. Defaults to 100

Example Request
  • let sdk = new Appwrite();
    
    sdk
        .setProject('')
    ;
    
    let promise = sdk.avatars.getCreditCard('amex');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Avatars;
    
    $client = new Client();
    
    $client
        ->setProject('')
        ->setKey('')
    ;
    
    $avatars = new Avatars($client);
    
    $result = $avatars->getCreditCard('amex');
  • const sdk = require('node-appwrite');
    
    // Init SDK
    let client = new sdk.Client();
    
    let avatars = new sdk.Avatars(client);
    
    client
        .setProject('')
        .setKey('')
    ;
    
    let promise = avatars.getCreditCard('amex');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });

Get Browser Icon

GET/avatars/browsers/{code}

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 /account/sessions endpoint. Use width, height and quality arguments to change the output settings.

Arguments

Name Type Description
code required string

Browser Code.

width optional integer

Image width. Pass an integer between 0 to 2000. Defaults to 100

height optional integer

Image height. Pass an integer between 0 to 2000. Defaults to 100

quality optional integer

Image quality. Pass an integer between 0 to 100. Defaults to 100

Example Request
  • let sdk = new Appwrite();
    
    sdk
        .setProject('')
    ;
    
    let promise = sdk.avatars.getBrowser('aa');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Avatars;
    
    $client = new Client();
    
    $client
        ->setProject('')
        ->setKey('')
    ;
    
    $avatars = new Avatars($client);
    
    $result = $avatars->getBrowser('aa');
  • const sdk = require('node-appwrite');
    
    // Init SDK
    let client = new sdk.Client();
    
    let avatars = new sdk.Avatars(client);
    
    client
        .setProject('')
        .setKey('')
    ;
    
    let promise = avatars.getBrowser('aa');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });

Get Country Flag

GET/avatars/flags/{code}

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.

Arguments

Name Type Description
code required string

Country Code. ISO Alpha-2 country code format.

width optional integer

Image width. Pass an integer between 0 to 2000. Defaults to 100

height optional integer

Image height. Pass an integer between 0 to 2000. Defaults to 100

quality optional integer

Image quality. Pass an integer between 0 to 100. Defaults to 100

Example Request
  • let sdk = new Appwrite();
    
    sdk
        .setProject('')
    ;
    
    let promise = sdk.avatars.getFlag('af');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Avatars;
    
    $client = new Client();
    
    $client
        ->setProject('')
        ->setKey('')
    ;
    
    $avatars = new Avatars($client);
    
    $result = $avatars->getFlag('af');
  • const sdk = require('node-appwrite');
    
    // Init SDK
    let client = new sdk.Client();
    
    let avatars = new sdk.Avatars(client);
    
    client
        .setProject('')
        .setKey('')
    ;
    
    let promise = avatars.getFlag('af');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });

Get Image from URL

GET/avatars/image

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.

Arguments

Name Type Description
url required string

Image URL which you want to crop.

width optional integer

Resize preview image width, Pass an integer between 0 to 4000

height optional integer

Resize preview image height, Pass an integer between 0 to 4000

Example Request
  • let sdk = new Appwrite();
    
    sdk
        .setProject('')
    ;
    
    let promise = sdk.avatars.getImage('https://example.com');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Avatars;
    
    $client = new Client();
    
    $client
        ->setProject('')
        ->setKey('')
    ;
    
    $avatars = new Avatars($client);
    
    $result = $avatars->getImage('https://example.com');
  • const sdk = require('node-appwrite');
    
    // Init SDK
    let client = new sdk.Client();
    
    let avatars = new sdk.Avatars(client);
    
    client
        .setProject('')
        .setKey('')
    ;
    
    let promise = avatars.getImage('https://example.com');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });

Get Favicon

GET/avatars/favicon

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

Arguments

Name Type Description
url required string

Website URL which you want to fetch the favicon from.

Example Request
  • let sdk = new Appwrite();
    
    sdk
        .setProject('')
    ;
    
    let promise = sdk.avatars.getFavicon('https://example.com');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Avatars;
    
    $client = new Client();
    
    $client
        ->setProject('')
        ->setKey('')
    ;
    
    $avatars = new Avatars($client);
    
    $result = $avatars->getFavicon('https://example.com');
  • const sdk = require('node-appwrite');
    
    // Init SDK
    let client = new sdk.Client();
    
    let avatars = new sdk.Avatars(client);
    
    client
        .setProject('')
        .setKey('')
    ;
    
    let promise = avatars.getFavicon('https://example.com');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });

Text to QR Generator

GET/avatars/qr

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.

Arguments

Name Type Description
text required string

Plain text to be converted to QR code image

size optional integer

QR code size. Pass an integer between 0 to 1000. Defaults to 400.

margin optional integer

Margin From Edge. Pass an integer between 0 to 10. Defaults to 1.

download optional integer

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.

Example Request
  • let sdk = new Appwrite();
    
    sdk
        .setProject('')
    ;
    
    let promise = sdk.avatars.getQR('[TEXT]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Avatars;
    
    $client = new Client();
    
    $client
        ->setProject('')
        ->setKey('')
    ;
    
    $avatars = new Avatars($client);
    
    $result = $avatars->getQR('[TEXT]');
  • const sdk = require('node-appwrite');
    
    // Init SDK
    let client = new sdk.Client();
    
    let avatars = new sdk.Avatars(client);
    
    client
        .setProject('')
        .setKey('')
    ;
    
    let promise = avatars.getQR('[TEXT]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });