Link

link.fish API

API to easily extract data from websites. Base URL All URLs referenced in the documentation have the following base: https://api.link.fish The REST API is…

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

API to easily extract data from websites.

Base URL

All URLs referenced in the documentation have the following base:

https://api.link.fish

The REST API is only served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

Authentication

HTTP requests to the REST API are protected with HTTP Basic authentication. You will use the email address of your link.fish account as the username and your API access token as the password for HTTP Basic authentication.

If you do not have an account yet, go to https://link.fish/api and create one first.

You will receive the API access token automatically via email after you signed up. To generate a new token and invalidate the current one log into your link.fish account at https://app.link.fish and go to: "Plugins" -> "API Dashboard"

There you can also see how many credits you used already.

Errors

The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:

{

  "status": {HTTP STATUS CODE}
  "message": "{ERROR MESSAGE}"
}

Like for example when the authorization is not provided or wrong:

{

  "status": 401
  "message": "Unauthorized"
}

Request IDs

Each API request has an associated request identifier. You can find it in the response headers, under X-LF-Request-Id. In case you have problems please provide this identifier that we can help you as good and fast as possible.

Example:

X-LF-Request-Id: f7f0036f-5277-421a-b143-f7a151571d18

Item format

The data is by default deeply nested. So if it should be checked if there is an offer with a price, the whole tree has to be checked. To make that simpler, it is also possible to return the data "flat". If selected it will flatten the tree by copying all the data to the main level under a property with the name of its type and link the data internally.

Information: We created a node module which allows converting between the two formats. It did not get open sourced yet. If you are in need, simply contact us via api@link.fish.

Response Content Type

By default, all data gets returned as JSON. If the data should be returned as XML add the following header:

Accept: application/xml

Credits

Depending on the request made a different amount of credits get charged. How many which request costs can be found on the API pricing page. Additionally, does a header named "X-LF-Credits-Charged" get added to each successful response with information about the credits.

Example:

X-LF-Credits-Charged: 1 # Credits used for current requests
X-LF-Credits-Subscription-Max: 1000 # Total credits available in subscription
X-LF-Credits-Subscription-Used: 512 # Credits still left in current month

You can check anytime how many credits you did use already by logging into your link.fish account at https://app.link.fish and checking under: "Plugins" -> "API Dashboard"

If you have problems, questions or improvement advice please send us an email to api@link.fish

Endpoints 8

REST-Endpoints

  • GETGet mobile apps/Urls/apps?url=string&return_urls=false&browser_render=falseVisits the URL and checks if there are mobile apps on them and returns the found ones. Will by default return the app identifiers and not the full URL to the…
  • GETExtract data (browser)/Urls/browser-data?url=string&item_format=normal&simplify_special_types=false&include_raw_html=false&screenshot=none&screenshot_width=640&screenshot_file_format=pngVisits the URL with a full browser and extracts the data. This request costs 5 credits.
  • GETGenerate screenshot (browser)/Urls/browser-screenshot?url=string&type=normal&file_format=png&width=640Visits the URL with full browser and creates a screenshot. This request costs 5 credits.
  • GETExtract data/Urls/data?url=string&item_format=normal&simplify_special_types=false&include_raw_html=false&browser_render=falseVisits the URL and extracts the data.
  • GETReturn data of JSON/XML/Urls/data-raw?url=stringVisits the URL and extracts the data.
  • GETReturn tabular data/Urls/data-tabular?url=string&selector=string&browser_render=falseVisits the URL and extracts tabular data.
  • GETGet geo coordinates/Urls/geo-coordinates?url=string&browser_render=falseVisits the URL and checks if there are Geo Coordinates on them and returns the found ones. Properties only get set when a value for both latitude and…
  • GETGet social media accounts/Urls/social-media?url=string&return_urls=false&browser_render=falseVisits the URL and checks if there are any social media accounts and returns the found ones. Will by default return the account identifiers and not the full…

API details

Base URL
https://api.link.fish
Authentication
HTTP Basic authentication (username and password)
Operations
8 operations on 8 pathsGET 8
Main resources
REST-Endpoints 8
Description format
Swagger 2.0, API version 2018-07-05
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the link.fish API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the link.fish API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get mobile apps” (GET /Urls/apps?url=string&return_urls=false&browser_render=false), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the link.fish API?

API to easily extract data from websites. Base URL All URLs referenced in the documentation have the following base: https://api.link.fish The REST API is… It is listed under Developer tools and has 8 endpoints.

Who publishes the link.fish API?

It is listed from Link's public API description (an OpenAPI document), not published by Link on Swastik Codes. Anyone who controls link.fish can claim the profile by adding a DNS TXT record.

What is the base URL of the link.fish API?

Requests go to https://api.link.fish. Endpoint paths are added to this base URL.

How do I authenticate with the link.fish API?

With HTTP Basic authentication (username and password).

How many endpoints does the link.fish API have?

8 operations on 8 paths (8 GET). The largest groups are REST-Endpoints.

Is forking the link.fish API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.