Open Graph

Extract open graph and social details from any website or URL with just one line of code!

Authentication

ApiStacks uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard.

Your API keys carry many privileges. To keep them from being abused, please do not share the keys on client-side code or Github etc. Keep them very secure.

All requests made to the API must contain the parameter api_key in each of your requests. API requests without authentication will fail.

All API requests must also be made over secure HTTPS. Requests made over plain HTTP may fail.

Endpoint

GET /getmeta

Parameters

api_key (required)

In your Request URL, provide the API Key found within your Dashboard

url (required)

The full URL (including its respective HTTP Protocol) of the website you want to request a screenshot from, e.g. http://abc.com

Premium Parameters

These parameters require a paid subscription to modify

response_type (optional)

Set to “JSON”, “XML”, or “YAML” depending what type of response you want from the API.

Want to test this API and get live results?

lIVE dEMO

Sample Request

curl --request GET \
--url 'https://api.apistacks.com/v1/getmeta?api_key={APIKEY}&url={url}' \

Sample Response

{
    "status": "ok",
    "timestamp": 1651635548542,
    "data": {
        "host": "digestyourfinances.com",
        "pathname": "/",
        "title": "Digest Your Finances - All Things Saving, Investing, Retirement, and Financial Freedom",
        "charset": "UTF-8",
        "description": "Let's Digest Your Finances by reading all the latest personal finance material relating to making money, saving money, early retirement, dealing with student loans, and your path to financial freedom.",
        "ogLocale": "en_US",
        "ogType": "website",
        "ogTitle": "Digest Your Finances",
        "ogDescription": "Let's Digest Your Finances by reading all the latest personal finance material relating to making money, saving money, early retirement, dealing with student loans, and your path to financial freedom.",
        "ogUrl": "https://digestyourfinances.com/",
        "ogSiteName": "Digest Your Finances",
        "ogImage": "https://digestyourfinances.com/wp-content/uploads/2020/03/SocialShareImage.jpg",
        "ogImageWidth": "1000",
        "ogImageHeight": "617",
        "ogImageType": "image/jpeg",
        "twitterCard": "summary_large_image",
        "twitterSite": "@digestfinances",
        "feeds": [
            {
                "type": "rss",
                "href": "https://digestyourfinances.com/feed/",
                "title": "Digest Your Finances » Feed"
            },
            {
                "type": "rss",
                "href": "https://digestyourfinances.com/comments/feed/",
                "title": "Digest Your Finances » Comments Feed"
            }
        ],
        "images": {}
    }
}

Rate Limiting

Each subscription has its own rate limit. Your limit is based on your subscription plan (free or paid). If you exceed your limits, don’t worry. You can always upgrade or downgrade at any time.

When you reach a rate limit (both daily and monthly), the service will stop responding and return an HTTP 429 response status code. The error will contain the following JSON string body text.

{
    "status": "fail",
    "data": "",
    "reason": "Usage limit reached. Please review/upgrade your account"
}

A reminder email will be sent to you when your API usage reaches 80% and 90% so that you can take immediate actions such as upgrading your plan in order to prevent your application using the API from being interrupted.

Error Codes

ApiStacks uses standard HTTP response codes to indicate the success or failure of an API request.

If the response code is not 200 Ok, it means the operation has failed. You can check the response for a field called ‘reason‘ that briefly explains what the error may be.

Status Code	Reason
400	The request was not complete or malformed. Parameters may be missing
401	API key was not provided or was not valid
403	Usage limit was likely reached or the app was not enabled in the dashboard
404	API Endpoint does not exist
405	Method is not allowed (Only use GET)
500	An error occurred on our end