This is a Python library for the Freelancer.com API. Using this, you can interact with Freelancer.com from your Python applications. It supports Python 2.7 and Python 3 (3.6+). For more about information about the Freelancer.com API, visit https://developers.freelancer.com.
Install it using pip install freelancersdk. It may be a good idea to
use virtualenv as
part of your workflow.
The current version series of the library is 0.1.x which corresponds to the
0.1 version of the API. The revision number x corresponds to the
revision of the SDK. The 0.1 series of the library will continue to
support (in a backward compatible way) the 0.1 version of the
Freelancer.com API.
The first step to using any SDK function is to create a Session object:
>>> from freelancersdk.session import Session >>> session = Session(oauth_token=token)
You must have a valid OAuth2 token before you can use the SDK or the API. See the Freelancer.com Developer portal for more information on how you can do so.
Once we have a session object, we can start using the SDK functions.
All the examples below recognizes two environment variables:
FLN_OAUTH_TOKEN: The OAuth2 token to create the session with and must be specifiedFLN_URL: If you want to use the library to make requests against the Freelancer.com Sandbox, you can specifiyFLN_URL=https://www.freelancer-sandbox.com. If not specified, it defaults tohttps://www.freelancer.com.
Projects
- Create a Fixed Project
- Create a Hourly Project
- Create a Local Project
- Create a Hireme Project
- Create a Freelancer Review
- Create a Employer Review
- Search for Projects
- Retrieve Project details
- Get a list of jobs (skills)
- Track a freelancer's location for a project
- Update a track's location
- Retrieve a track by ID
- Retrieve a single project's details
Bids
- Create a Bid
- Award a Bid
- Accept a bid
- Revoke a Bid
- Retract a Bid
- Highlight a Bid
- Retrieve project bids
Milestone Payments
- Create a Milestone payment
- Create a Milestone payment request
- Accept a Milestone payment request
- Reject a Milestone payment request
- Delete a Milestone payment request
- Release Milestone payment request
- Cancel Milestone payment request
- Request a Milestone payment release
- Retrieve project milestones
- Retrieve a milestone by ID
Messaging
- Create a new thread in the context of a project
- Create a new message in an existing thread
- Upload an attachment in an exising thread
- Retrieve messages
- Retrieve threads
- Search for messages
Contests
Users
- Add a job to a user's list of jobs
- Delete a job from a user's jobs
- Set a user's list of jobs
- Retrieve user details
- Retrieve a single user's details
- Search for freelancers
- Retrieve the current user's details
- Retrieve user reputations
- Retrieve user portfolios
GNU LGPLv3. Please see LICENSE and COPYING.LESSER.
Please note that 0.1.3 release changed the LICENSE from BSD to GNU LGPLv3. If you were using the library prior to this release, please file a issue to let us know if the change affects you in any way.