getPin accepts almost any Pinterest reference:
- a full URL
- a short link (
pin.it/...) - a
/pin/<id>/path - a regional host (
br.pinterest.com/...) - a bare pin ID
Pin fields
string
Pin ID, for example
"1060738518503398158".string
Pin title.
string
Pin description.
string
Highest-resolution image URL.
{ url, width?, height? }[]
All image variants, sorted largest first.
boolean
true for video and story pins.string
Best
.mp4 URL. Empty for plain image pins.string
Outbound link, if the pinner attached one.
string
Source domain, if any.
string
SEO or auto-generated alt text, if present.
number
Creation time in epoch milliseconds, if present.
{ id?, username?, fullName?, image? }
The user who saved the pin.
{ id?, name?, url? }
The board the pin belongs to.
NotFoundError. See Error handling.
To download the pin’s image or video, see Downloading media.