# URL options

Everything the iframes read from their URL, grouped by purpose, with the default and an example of each option.

> Only `key` is required. An option that is misspelled, or whose value is malformed, is simply not applied: the viewer keeps that option's default. A malformed `cert`, `def` or `paint` shows an error in place of the item, since there is no item to show.

## Access

Identifies your account.

- `key`

  Default Required

  Your publishable key.

  Starts with `pk_`

  Example `key=pk_prod_your_key`

## Item

The item the viewer shows.

[How to name the item, in Iframes](https://render.vskin.gg/docs/iframes#choose-item)

- `cert`

  Default None

  The item's certificate, returned for every item by Steam's public inventory API. Renders the exact item, cosmetics included. Recent inspect links end with it; older ones carry none.

  Hex string

  Example `cert=80907B511F0241819887A01389A886B089B87A101E7583C05683C880D081E29988819074BD9D76A89CBFAD8080CCC2BD90C5B43DC58004723AE29988839074BD9D8A57A3BFAD80805842BDFAB6EDBEC5B01E1FBCE29988839074BD9DE6E6A6BFAD8080CCC2BD0D1D0BBEC5802E003AE29988839074BD9D1A1999BFAD80807042BD5D8024BEC560F02DBCE29988829073BD9D2EC7A1BFAD8080F0C1BDD01ADDBEC580ABBABBE81C82F0882281978880908CBD3DF845C1C5A99536BECDCFC895C0D05A1C85110C776A`

- `def`

  Default None

  Item definition index (defindex). Required with the paint kit index.

  Integer

  Example `def=7`

- `paint`

  Default None

  Paint kit index. Required with the defindex; `0` for an agent or a weapon without a skin.

  Integer

  Example `paint=1171`

- `seed`

  Default `0`

  Pattern seed.

  Integer from 0 to 1000

  Example `seed=470`

- `float`

  Default `0`

  Wear (float).

  Decimal from 0 to 1

  Example `float=0.3272`

- `stattrak`

  Default Off

  Adds a StatTrak™ counter.

  Values `1`

  Example `stattrak=1`

- `kills`

  Default `0`

  The count on the StatTrak™ counter.

  Integer

  Example `kills=1`

- `name`

  Default None

  Name tag text.

  Text, URL-encoded

  Example `name=Hydro%20AK`

- `stickers`

  Default None

  Stickers and their slots. A certificate also carries their wear and position; here, only their id and slot.

  `id:slot` pairs, comma separated

  Example `stickers=7924:1,7923:2`

- `charm`

  Default None

  The charm, its pattern and, for a Sticker Slab, the sticker inside.

  `id`, `id:pattern` or `id:pattern:stickerId`

  Example `charm=12:85594`

- `patches`

  Default None

  An agent's patches and their slots.

  `id:slot` pairs, comma separated

  Example `patches=4550:0,4553:1`

## Scene

The environment around the item.

- `env`

  Default `showroom`

  The environment around the item: the showroom, or one of the game's maps with its exact in-game lighting and scenery.

  An environment id, from the list below

  Example `env=de_dust2`

- `backdrop`

  Default `true`

  `false` removes the backdrop so your page shows behind the item.

  Values `true` `false`

  Example `backdrop=false`

Environments available now:

`showroom` `de_ancient` `de_ancient_night` `de_anubis` `ar_baggage` `de_cache` `de_dust2` `de_inferno` `cs_italy` `de_mirage` `de_nuke` `cs_office` `de_overpass` `de_train` `de_vertigo` `warehouse`

## Brand and language

Make the viewer look and speak like your site.

- `title` Basic iframe only

  Default From the item

  Replaces the item name shown in the viewer.

  Text, URL-encoded

  Example `title=AK-47%20%7C%20Inheritance`

- `accent` Basic iframe only

  Default From the item

  Color of the bar next to the item name. Defaults to the item's rarity color.

  CSS color, with `#` written `%23`

  Example `accent=%23ff7a00`

- `lang`

  Default `en`

  Language of the viewer's HUD and notices.

  Values `en` `fr` `zh` `hi` `es` `ar` `bn` `pt` `ru` `ja` `de` `ko` `tr` `vi` `it` `pl`

  Example `lang=fr`

- `watermark`

  Default `true`

  `false` removes the watermark behind the item, ours or yours.

  Values `true` `false`

  Example `watermark=false`

- `backdrop-image`

  Default None

  One of your backdrops, in place of ours at the showroom; a map keeps its own scenery. Applied when your key's plan has Brand and the file is in your account. `backdrop=false` wins over it.

  A backdrop id from your [dashboard](https://render.vskin.gg/dashboard)

  Example `backdrop-image=bkg_your_backdrop_id`

- `watermark-image`

  Default None

  One of your watermarks, over the backdrop and behind the item in place of ours, at the showroom. Applied when your key's plan has Brand and the file is in your account. `watermark=false` wins over it.

  A watermark id from your [dashboard](https://render.vskin.gg/dashboard)

  Example `watermark-image=wmk_your_watermark_id`

- `theme-<token>`

  Default VSkin colors

  One color of the HUD theme. Applied when you have the Brand option.

  Six-digit hex color, with or without `#`

  Example `theme-primary=ff7a00`

  All 5 names

  Both iframes

  `theme-primary` `theme-hud-surface` `theme-hud-border` `theme-hud-fill` `theme-text-main`

## Behavior

How the viewer behaves.

- `interactive`

  Default `true`

  `false` turns off rotation and zoom by the visitor.

  Values `true` `false`

  Example `interactive=false`

- `autoplay`

  Default Off

  `1` plays the inspect animation on load, and again a few seconds after the visitor stops interacting. Not played on agents.

  Values `1`

  Example `autoplay=1`

## HUD

What the viewer's HUD shows. These options only hide elements; which ones exist depends on your plan.

- `hud`

  Default `true`

  `false` hides the whole HUD.

  Values `true` `false`

  Example `hud=false`

- `hud-size`

  Default `medium`

  Size of the HUD. Ignored when the viewer is narrower than 768 px.

  Values `small` `medium` `large`

  Example `hud-size=small`

- `hud-<element>`

  Default Follows hud

  Hides or shows one HUD element, whatever `hud` says. Only hides what your plan includes.

  Values `true` `false`

  Example `hud-inspect-link=false`

  All 31 names

  Both iframes

  `hud-rotation-anim` `hud-select-environment`

  Basic iframe only

  `hud-item-title` `hud-item-card` `hud-cosmetics-thumbnails` `hud-agent-weapon`

  Advanced iframe only

  `hud-deck-swap` `hud-subject-panel` `hud-edit-seed` `hud-edit-float` `hud-edit-stattrak` `hud-edit-nametag` `hud-cosmetics` `hud-cosmetics-edit` `hud-cosmetics-placement` `hud-view-mode` `hud-view-mode-first-person` `hud-view-mode-third-person` `hud-viewmodel-settings` `hud-handedness` `hud-subject-facing` `hud-weapon-sound` `hud-weapon-anims` `hud-agent-anims` `hud-screenshot` `hud-fullscreen` `hud-reset` `hud-inspect-link` `hud-select-weapon` `hud-select-gloves` `hud-select-agent`

- `screenshot-hud` Advanced iframe only

  Default `true`

  Screenshots carry the item's details: name, wear, pattern seed and cosmetics. `false` leaves them out: the image then carries the render, with our signature unless you have the Brand option.

  Values `true` `false`

  Example `screenshot-hud=false`
