Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
UltimaHoarder authored May 31, 2020
1 parent 7638e71 commit 440596d
Showing 1 changed file with 5 additions and 24 deletions.
29 changes: 5 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,16 @@ file_name_format:

Default = "{file_name}.{ext}"

{id} = The media's ID (onlyfans-specific) [UNIQUE]

{file_name} = The media's file name [UNIQUE]

{username} = The account's username

{date} = The post's date

{id} = The media's ID (onlyfans-specific)

{text} = The media's text (You will get errors; don't use this)

{file_name} = The media's file name

{ext} = The media's file extension

Example: {date}/{text}-{file_name}.{ext}
Expand All @@ -79,7 +79,7 @@ text_length:

Default = ""
Ideal = "50"
Max = "240"
Max = "255"

When you use {text} in file_name_format, a limit of how many characters can be set by inputting a number.

Expand Down Expand Up @@ -215,25 +215,6 @@ ignore_unfollowed_accounts:

The script will download metadata files only.

# API

You can import the following functions from modules.onlyfans
These functions will go through various changes, so each commit may break your code.

create_session(user_agent, auth_id, auth_hash, app_token)

This function will try to create and return a authenticated session along with your subscriber count.

get_subscriptions(session, app_token, subscriber_count)

This function will return an array of all the accounts you're subscribed too.


start_datascraper(session, app_token, username)

This function will scrape the username/link you pass.
The function will return true if scrape has finished and false if something went wrong.

# FAQ
Before troubleshooting, make sure you're using Python 3.8.

Expand Down

0 comments on commit 440596d

Please sign in to comment.