Skip to main content

An API Client Library for Rapnet for Python 3

Project description

Rapnet Python SDK
==========

.. image:: https://badge.fury.io/py/rapnet.svg
:target: https://badge.fury.io/py/rapnet

This is a very primary API Client Library to work with Rapnet_.

----

Currently it only supports `Premium JSON API`_ and `Price List API`_, DSL_ and `Upload API`_.


============
Installation
============
Via pip:

.. code:: bash

pip install rapnet


=====
Usage
=====
Simply Instantiate a ``RapNetAPI`` object with proper ``usernmae`` and ``password``.

.. code:: python

from rapnet import RapNetAPI
rapi = RapNetAPI(username, password)


Functions
---------

**get_price_sheet_info**
*Arguments: None*
Returns price sheet's metadata.

**get_price_sheet**
*Arguments: Shape[Optional]*
Returns price list sheet by shape.

**get_price_changes**
*Arguments: Shape[Optional]*
Returns price changes by shape.

**get_price**
*Arguments: params(format: JSON)[Optional]*
Returns filtered price list. For filters consult `Price Doc`_.

**get_diamonds_list**
*Arguments: params(format: JSON)[Optional]*
Returns paginated, filtered diamond details. For filter parameters consult `Details Doc`_.

**get_diamond**
*Arguments: id(format: Integer)*
Return a single diamond detail by ID.

**get_all_diamonds**
*Arguments: datafile(format: String)[Optional]*
Return all diamonds details in the API. Time Consuming, Beware!

**get_dsl**
*Arguments: datafile(format: String)[Optional]*
Get Download Listing Service Data. Extra supscription needed.

**upload_string**
*Arguments: datastring(format: String)*
Upload single diamond details in a string.
For formatting details consult:
https://technet.rapaport.com/Info/LotUpload/Upload_HTTP.aspx

**upload_csv**
*Arguments: uploadfile(format: String)*
Upload diamonds details in a csv file.
For formatting details consult:
https://technet.rapaport.com/Info/LotUpload/Upload_HTTP.aspx

.. _Rapnet: https://technet.rapaport.com
.. _`Premium JSON API`: https://technet.rapaport.com/Info/RapLink/Format_Json.aspx
.. _`Price Doc`: https://technet.rapaport.com/Info/Prices/Format_Json.aspx
.. _`Details Doc`: https://technet.rapaport.com/Info/RapLink/Format_Json.aspx
.. _`Price List API`: https://technet.rapaport.com/Info/Prices/Format_Json.aspx
.. _DSL: https://technet.rapaport.com/Info/Dls/Integration.aspx
.. _`Upload API`: https://technet.rapaport.com/Info/Landing/UploadDiamonds.aspx

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rapnet-2.1.9.tar.gz (4.8 kB view hashes)

Uploaded source

Built Distribution

rapnet-2.1.9-py3.6.egg (9.0 kB view hashes)

Uploaded 3 6

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page