Methods Palettes

List of palette methods and parameters

Method	Description	Parameter	Returns
palette	Get a single palette	integer $paletteID OR array $query	array
palettes	Get multiple palettes	array $query	array
palettes_top	Get top palettes	array $query	array
palettes_new	Get new palettes	array $query	array
palettes_random	Get random palettes	[none]	array

For palette methods, the parameter $query array can include the following keys:

• format
• jsonCallback
• showPaletteWidths
• lover – Not available for palette()
• hueOption – Not available for palette()
• hex – Not available for palette()
• keywords – Not available for palette()
• keywordExact – Not available for palette()
• orderCol – Not available for palette()
• sortBy – Not available for palette()
• numResults – Not available for palette()
• resultOffset – Not available for palette()

More information on $query keys and return values at the ColourLOVERS.com API page

Sample code: single palette

require_once('ColourLovers.php');
$c = new ColourLovers;
$result = $c->palette(1097823);
print_r($result);
/*
Array
(
    [@attributes] => Array
        (
            [numResults] => 1
            [totalResults] => 1
        )
    [palette] => Array
        (
            [id] => 1097823
            [title] => Lena's Love Letter
            [userName] => LovelyLena
            [numViews] => 1871
            [numVotes] => 59
            [numComments] => 28
            [numHearts] => 4.5
            [rank] => 3
            [dateCreated] => 2010-02-04 2:13:53
            [colors] => Array
                (
                    [hex] => Array
                        (
                            [0] => F04155
                            [1] => FF823A
                            [2] => F2F26F
                            [3] => FFF7BD
                            [4] => 95CFB7
                        )
                )
            [description] => Removed for documentation brevity. There was a bunch of text here.
            [url] => http://www.colourlovers.com/palette/1097823/Lenas_Love_Letter
            [imageUrl] => http://www.colourlovers.com/paletteImg/F04155/FF823A/F2F26F/FFF7BD/95CFB7/Lenas_Love_Letter.png
            [badgeUrl] => http://www.colourlovers.com/images/badges/pw/1097/1097823_Lenas_Love_Letter.png
            [apiUrl] => http://www.colourlovers.com/api/palette/1097823
        )
)
*/

Sample code: multiple palettes

require_once('ColourLovers.php');
$c = new ColourLovers;
$results = $c->palettes(array(
	'hueRange'	=> '12,68',
	'numResults'=> 2
));