Please Login.

You need to login to your Freestream.to-Account in order to get your
personal API-Key!

Below you can check out the documentation
on how to use the API and what you can do with it.
But you will have to know your API-Key in order to use the API.

> LOGIN <

Documentation - How to use the API

Contents
General Workflow
> CHECK
> CRAWL
> SUBMIT
   > SPECIAL REQUIREMENTS
  • General Workflow

    CHECK
    CRAWL
    SUBMIT
  • CHECK - Check if movie exists

    Use the URL below to check for state of a specific Movie you want to submit.
    You will have to perform a POST request and send at least all required parameters listed below.

    With this command you can check if you'd get promted to provide more information on the movie itself
    or if it already exists and you just can submit your links.

    If it doesn't exist yet there may be certain additional information required and you can't submit your link without providing these.

    So use this option in the first place if your script/program is not able to provide additional information itself.

    But don't worry if you can't crawl yourself. There's still the chance that there is no entry at all in our database.
    If so we will try to get all information automatically. See section "CRAWL".

    URL:

    https://freestream.to/api/check/?APIKEY=[YOURAPIKEY]

    Response Format:   XML

    Request-Parameters:

    NameHttp-MethodRequired/OptionalValues/Description
    APIKEYGETREQUIREDVALID VALUES: "YOUR API-KEY"
    This is your identifier for the API. Your API-KEY is unique and bound to your user account. Keep it secret! It's your authentification for API-Requests.
    TYPEPOSTREQUIREDVALID VALUES: "MOV" / "SER" / "XXX"
    Specify the type of movie you want to check the state for. We need to know what movie type the given Id belongs to.
    IDPOSTREQUIRED

    VALID VALUES: e.g. "tt0499549" / "tt0944947" / "Pirates.2.XXX.2008.Bluray.VC1.720P.5.1.WMV-NOVO" or

    "Pirates II: Stagnettis Revenge"

    For MOVIES: use the public IMDB-ID in the format "tt[0-9]+"

    For SERIES: use the public IMDB-ID in the format "tt[0-9]+"

    For XXX: use the unmodified scene-releasename like "Pirates.2.XXX.2008.Bluray.VC1.720P.5.1.WMV-NOVO".
    For best results use a releasename that can be found on xrel.to or similar sites. Do not remove any dots etc!

     

    For XXX: You can also try to use normal name like

    "Pirates II: Stagnettis Revenge" !

    LANGPOSTREQUIREDVALID VALUES: "EN" / "DE"
    Specify the language you want to check the Movie-State for.
    Different languages can result in completely different results!
    So check for the language you actually want to submit your stream link for.

    Response-Parameters:

    NamePossible ValuesDescription
    SUCCESSTRUEIndicates that the request was successfull.
    FALSEIndicates that the request was NOT successfull.
    An Error occured! See "Error".
    ERRORINVALID_APIKEYThe API-KEY you sent in your request is not associated with an user account.
    INVALID_TYPEThe MOVIE-TYPE you sent in your request has not a valid value. Checkout the documentation!
    INVALID_IDThe MOVIE-ID you sent in your request seems to be invalid. Checkout the documentation!
    PARAMETER_MISSINGA required parameter is missing in your request. Checkout the documentation!
    STATEThis Parameter is only set when the request was successfull. If so, there are the following possible values:
    EXISTSThe Movie already exists in our Database. You can directly go to the "SUBMIT" section and submit your streaming links!
    PREPAREDThe Movie information is already present in our Database but no link has been submitted yet.
    You can now submit your links along with potentially missing movie-information. See Response-Parameter "Required-Information".
    NOT_PREPAREDThe Movie is not present in our Database with any information. Information need to be crawled first.
    If you want to submit your streaming links you first have to trigger the crawling and wait for the response. See the "CRAWL" section.
    Required-InformationThe following values are arrays with names of the needed or optional movie-infos in the specified language.
    You only have to fullfill the requirements for your streaming link's language.
    Per value you get one XML-Node in the Response.
    for MOVIES / SERIES :
    NEEDEDPossible Elements:
    [ "YEAR" ]
    NEEDED_ENPossible Elements:
    [ "TITLE_EN" , "DESC_EN" , "GENRE_EN" , "COVER_EN" ]
    NEEDED_DEPossible Elements:
    [ "TITLE_DE" , "DESC_DE" , "GENRE_DE" , "COVER_DE" ]
    OPTIONALPossible Elements:
    [ "RUNTIME" ]

    You will only get the missing information for the language you specified in your request!
    So either "NEEDED_EN" or "NEEDED_DE" will be missing in the response.

    for SERIES only :
    SEASON_EPISODESFormat: "   SEASON_S_EPISODES_E   "
    Where S = Season Number and E = Episodes in Season.
    e.g. "SEASON_1_EPISODES_8

    This Parameter only shows up for series and indicates how many Episodes there are possible per Season.
    To submit a link your provided season and episode information has to match the range for the specific season.

    So if there is a "SEASON_EPISODES"-Parameter with "SEASON_1_EPISODES_8" as value, there is season 1 and it contains episodes 1 to 8.
    So in this example you could submit a link with season-parameter set to 1 and episode-parameter set to 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8.

    This normally covers all Seasons and Episodes that are available on IMDB for this Serie.
    This ensures that you can only submit existing episodes of the serie.

    for XXX :
    NEEDEDPossible Elements:
    [ "TITLE" , "GENRE" , "COVER" ]
    OPTIONALPossible Elements:
    [ "DESC" , "YEAR" , "RUNTIME" ]

    XXX-Movies are language independent and mostly in english.
    It depends on the certain release so there is no differentiation between languages here.

  • CRAWL - Trigger crawl action or Get state

    Use the URL below to trigger a CRAWL-Action or get the state of a specific Movie if it already exists in our databse.
    You will have to perform a POST request and send at least all required parameters.

    The Request- and Respnose-Parameters are equal to the "CHECK" section.
    PLUS the LANG-Parameter which is explained in the list below
    and replaces the LANG-Parameter specified in the "CHECK" section (just its meaning).

    The only difference is that you directly trigger the CRAWLING if the current state
    of the specified Movie is "NOT_PREPARED" (i.e. there's no entry at all in our database yet).

    The crawling itself may take a while and is a blocking pocess.
    That means that your request will take a while and does not respond until the crawling is done.

    If its done you will get exactly the same Response-Parameters as in section "CHECK" specified.

    URL:

    https://freestream.to/api/crawl/?APIKEY=[YOURAPIKEY]

    Response Format:   XML

    Request-Parameters:

    NameHttp-MethodRequired/OptionalValues/Description
    LANGPOSTREQUIREDVALID VALUES: "EN" / "DE"
    Specify the language you want to trigger the CRAWLING for.
    Set the language you actually want to submit a link for!
    Otherwise you may not be able to submit you link due to missing movie information.
  • SUBMIT - Submit your streamlinks

    Use the URL below to submit your streamlink link(s) along with additional information about the movie if needed.
    You will have to perform a POST request and send at least all required parameters listed below.

    With this command you can finally submit your streaming links and cash in!
    If everything goes well and your input is valid you'll get a certain amount of gold-Coins credited to your user account.

    URL:

    https://freestream.to/api/submit/?APIKEY=[YOURAPIKEY]

    Response Format:   XML

    Request-Parameters:

    NameHttp-MethodRequired/OptionalValues/Description
    APIKEYGETREQUIREDVALID VALUES: "YOUR API-KEY"
    This is your identifier for the API. Your API-KEY is unique and bound to your user account. Keep it secret! It's your authentification for API-Requests.
    TYPEPOSTREQUIREDVALID VALUES: "MOV" / "SER" / "XXX"
    Specify the type of movie you want to submit a link for. We need to know what movie type the given Id belongs to.
    IDPOSTREQUIREDVALID VALUES: e.g. "tt0499549" / "tt0944947" / "Pirates.2.XXX.2008.Bluray.VC1.720P.5.1.WMV-NOVO"
    For MOVIES: use the public IMDB-ID in the format "tt[0-9]+"

    For SERIES: use the public IMDB-ID in the format "tt[0-9]+"

    For XXX: use the unmodified scene-releasename like "Pirates.2.XXX.2008.Bluray.VC1.720P.5.1.WMV-NOVO".
    For best results use a releasename that can be found on xrel.to or similar sites. Do not remove any dots etc!
    LANGPOSTREQUIREDVALID VALUES: "EN" / "DE"
    Specify the language for your streaming link.
    The stream must be in the specified language and
    you must fullfill all required additional movie information for this language.
    SEASONPOSTOPTIONALOnly for SERIES:
    Season-Number
    EPISODEPOSTOPTIONALOnly for SERIES:
    Episode-Number
    For each singel link use a seperat POST-Parameter with the following format:
    LINKPOST

    "LINK_1_0=[yourFirstLink]"
    LINK_2_0=[yourSecondLink]"
    LINK_3_0=[yourThirdLink]"
    "LINK_4_0=[yourFourthLink]"
      "LINK_4_1=[theSecondPartOfTheMovieForYourForthLink]"
    and so on...

    In general you put one POST-Parameter for each link you submit and

    name it "  LINK_I_P  "

    where I is the incrementing (unique) index
    and P the part number of your link.

    Leave P = 0 if your movie is just a singel link.

    Increment it for each part by 1 if your movie is splitted up into several parts!

    Request-Parameter "Required-Information":


    You will have to provide certain information if they are not available in out database yet.
    Which parameters are required and which are optional
    you know from the "CHECK" or "CRAWL" command you should have performed before.

    Every Parameter has to be a singel POST-Field!

    The list below is an overview over all possible Parameters that you can specify.

    Also note the special requirements for cover-images and the genre option
    in the section "Special Requirements" you can find below the list.

    NameDescription
    TITLE_ENThe movie title in english. E.g. "Avatar"
    TITLE_DEThe movie title in german. E.g. "Avatar - Aufbruch nach Pandora"
    TITLEThe movie title of a porn movie (language independent). E.g. "Pirates 2 - Stagnetti's Revenge"
    RUNTIMEThe runtime of the movie in minutes. Only put the number! E.g. 242
    YEARThe year of release.
    COVER_ENAn english movie poster.
    A direct link to a JPG-Image hosted on an allowed imagehoster (see below).
    COVER_DEA german movie poster.
    A direct link to a JPG-Image hosted on an allowed imagehoster (see below).
    COVERA movie poster for a porn movie (language independent).
    A direct link to a JPG-Image hosted on an allowed imagehoster (see below).
    GENRE_ENThe genre of the movie in english. You have to choose the value from the list below! It's case sensitive!
    GENRE_DEThe genre of the movie in german. You have to choose the value from the list below! It's case sensitive!
    GENREThe genre of the porn movie (language independent).
    You have to choose the value from the list below! It's case sensitive!

    Response-Parameters:

    NamePossible ValuesDescription
    SUCCESSTRUEIndicates that the request was successfull.
    FALSEIndicates that the request was NOT successfull.
    An Error occured! See "Error".
    ERRORNOT_PREPAREDThe movie your are trying to submit links for does not exists in our database!
    Call "CRAWL" first.
    INVALID_APIKEYThe API-KEY you sent in your request is not associated with an user account.
    INVALID_TYPEThe MOVIE-TYPE you sent in your request has not a valid value. Checkout the documentation!
    INVALID_IDThe MOVIE-ID you sent in your request seems to be invalid. Checkout the documentation!
    PARAMETER_MISSING_OR_INVALIDA required parameter is missing in your request.
    Or it does not match the requirements! See "Special Requirements".
    Is your COVER-Link correct? Is your GENRE-Value in the list?
    Checkout the documentation!
    REWARDPOSSIBLE VALUES:
    POSITIVE NUMBER OR 0
    Amount of gold-Coins you've got credited to your user account.
    NOT_APPROVED_HOSTERIf you find this parameter in your response you have submitted one or more links hosted on hosters
    that have not been aproved by us yet.
    Affected hosters are listed in this parameter.

    We fight spam and malware. Therefore we check unkown hosters before the links are made visible to the public.

    Your links have been saved and will be visible as soon as the specific hoster is approved.

    Special Requirements:


    You will have to provide certain information if they are not available in our database yet.
    Which parameters are required and which are optional
    you know from the "CHECK" or "CRAWL" command you should have performed before.

    The list below is an overview over all possible Parameters that you can specify.

    Also note the special requirements for cover-images and the genre option
    in the section "Special Requirements" you can find below the list.

    COVER REQUIREMENTSOnly direct links to JPG-Images hosted on the following hosters are allowed:

    www.directupload.net
    www.anyimg.com
    www.imgur.com

    GENRE REQUIREMENTS


    For each MOVIE-TYPE there are different GENRE VALUES you can choose from.
    Please use them in the exact manner. It is CASE SENSITIVE.
    These values can change (amount will grow) from time to time.

    MOVIES (ENGLISH)SERIES (ENGLISH)XXX (ENGLISH)
    ActionAction4hourdvds
    AdultAdventureAction
    AdventureAnimationAffairs
    AnimationBiographyAllGirl&Lesbian
    BiographyComedyAlternativeSex
    ComedyCrimeAmateur
    CrimeDocumentaryAnal
    DocumentaryDramaAnime
    DramaFamilyAsian
    FamilyFantasyAsstoMouth
    FantasyGame-ShowAthletic
    Film-NoirHistoryAuditions
    Game-ShowHorrorAwardWinners
    HistoryMusicBabysitter
    HorrorMusicalBathroom
    MusicMysteryBehindTheScene
    MusicalNewsBehindTheScenes
    MysteryReality-TVBi-Sexual
    NewsRomanceBigButts
    Reality-TVSci-FiBigDick
    RomanceShortBigTits
    Sci-FiSportBlackGirls
    ShortTalk-ShowBlondes
    SportThrillerBlowjobs
    Talk-ShowWarBondage
    ThrillerWesternBrazilian
    WarBrunettes
    WesternCanadian
    Celebrity
    Cheerleaders
    College
    Compilation
    Couples
    CreamPie
    Cuckold
    Cumshots
    DeepThroat
    Domination
    DoublePenetration
    Ebony
    EroticVignette
    European
    FaceSitting
    Facials
    FatChicks
    Fetish
    Fingering
    Fisting
    Gangbang
    Gay
    German
    Glasses
    Gonzo
    Groupsex
    Handjob
    Hardcore
    Housewives
    Indian
    Interracial
    Japanese
    Jeans
    Latino
    Massage
    Masturbation
    MILF
    Military
    Movie
    Muscled
    Natural
    Nurses
    Office
    Oiled
    Old&Young
    Oral
    Orgy
    Outdoor
    P.O.V.
    ParodyMovies
    PartySex
    PornforWomen
    Public
    Redhead
    Roleplays
    Romance
    Russian
    S-M
    She-Male
    SmallTits
    Softcore
    Squirting
    Straight
    Strap-On
    Stripping
    Swingers
    Tattoo
    Teen18+
    Threesomes
    Transsexual
    Uniform
    Voyeur
    Western
    Wrestling&Fighting
    X-Mas
    Young&Students
    MOVIES (GERMAN)SERIES (GERMAN)XXX (GERMAN)
    AbenteuerAbenteuer4hourdvds
    ActionActionAction
    AmateurAmateurAffairs
    AnimationAnimationAllGirl&Lesbian
    AnimeAnimeAlternativeSex
    BiographieBiographieAmateur
    DokumentationDokumentationAnal
    DramaDramaAnime
    EasternEasternAsian
    ErotikErotikAsstoMouth
    EssayfilmFantasyAthletic
    ExperimentalfilmGruselAuditions
    FantasyHeimatfilmAwardWinners
    Film-NoirHistorienfilmBabysitter
    GruselHorrorBathroom
    HeimatfilmK.A.BehindTheScene
    HistorienfilmKampfsportBehindTheScenes
    HorrorKatastrophenBi-Sexual
    K.A.Kinder-FamilienfilmBigButts
    KampfsportKomödieBigDick
    KatastrophenKriegBigTits
    Kinder-FamilienfilmKrimiBlackGirls
    KomödieKurzfilmBlondes
    KriegLiebe-RomantikBlowjobs
    KrimiMusicalBondage
    KurzfilmMusikfilmBrazilian
    Liebe-RomantikMysteryBrunettes
    MondoScience-FictionCanadian
    MusicalSportfilmCelebrity
    MusikfilmThrillerCheerleaders
    MysteryTierfilmCollege
    Science-FictionWebserieCompilation
    SerialWesternCouples
    SexCreamPie
    SplatterCuckold
    SportfilmCumshots
    StummfilmDeepThroat
    ThrillerDomination
    TierfilmDoublePenetration
    TV-FilmEbony
    TV-Mini-SerieEroticVignette
    TV-PilotfilmEuropean
    TV-SerieFaceSitting
    WebserieFacials
    WesternFatChicks
    Fetish
    Fingering
    Fisting
    Gangbang
    Gay
    German
    Glasses
    Gonzo
    Groupsex
    Handjob
    Hardcore
    Housewives
    Indian
    Interracial
    Japanese
    Jeans
    Latino
    Massage
    Masturbation
    MILF
    Military
    Movie
    Muscled
    Natural
    Nurses
    Office
    Oiled
    Old&Young
    Oral
    Orgy
    Outdoor
    P.O.V.
    ParodyMovies
    PartySex
    PornforWomen
    Public
    Redhead
    Roleplays
    Romance
    Russian
    S-M
    She-Male
    SmallTits
    Softcore
    Squirting
    Straight
    Strap-On
    Stripping
    Swingers
    Tattoo
    Teen18+
    Threesomes
    Transsexual
    Uniform
    Voyeur
    Western
    Wrestling&Fighting
    X-Mas
    Young&Students