uex-api-sdk 1.0.1

UEX API

Getting Started with UEX Corp API

Introduction

Created by @thekronny.

Downloads

Secification file

Other Resources

Contact Support: Name: Official Discord

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install uex-api-sdk==1.0.1

You can also view the package at: https://pypi.python.org/pypi/uex-api-sdk/1.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. Default: Environment.PRODUCTION
http_client_instance	HttpClient	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 30
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ['GET', 'PUT']
logging_configuration	LoggingConfiguration	The SDK logging configuration for API calls
bearer_credentials	BearerCredentials	The credential object for OAuth 2 Bearer token
api_key_credentials	ApiKeyCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

import logging

from uexcorpapi.configuration import Environment
from uexcorpapi.http.auth.api_key import ApiKeyCredentials
from uexcorpapi.http.auth.bearer import BearerCredentials
from uexcorpapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from uexcorpapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from uexcorpapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from uexcorpapi.uexcorpapi_client import UexcorpapiClient

client = UexcorpapiClient(
    bearer_credentials=BearerCredentials(
        access_token='AccessToken'
    ),
    api_key_credentials=ApiKeyCredentials(
        secret_key='secret_key'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Authorization

This API uses the following authentication schemes.

• bearer (OAuth 2 Bearer token)
• apiKey (Custom Header Signature)

List of APIs

• Categories
• Categories Attributes
• Cities
• Commodities
• Commodities Alerts
• Id Commodity
• Commodity Code
• Commodity Name
• Commodity Slug
• Id Terminal
• Terminal Code
• Terminal Name
• Terminal Slug
• Commodities Prices All
• Commodities Ranking
• Commodities Raw Prices All
• Id Orbit Origin
• Id Planet Origin
• Id Terminal Origin
• Commodities Status
• Companies
• Contacts
• Contracts
• Specialization
• Data Extract
• Data Parameters
• Factions
• Fleet
• Fuel Prices All
• Game Versions
• Id Category
• Id Company
• Size
• Uuid
• Id Item
• Items Prices All
• Jump Points
• Jurisdictions
• Marketplace Favorites
• Marketplace Listings
• Moons
• Orbits
• Orbits Distances
• Id Organization
• Slug
• Outposts
• Planets
• Poi
• Refineries Audits
• Refineries Capacities
• Refineries Methods
• Refineries Yields
• Release Notes
• Space Stations
• Star Systems
• Terminals
• Terminals Distances
• User
• User Refineries Jobs
• User Trades
• Vehicles
• Vehicles Loaners
• Vehicles Prices
• Vehicles Purchases Prices All
• Vehicles Rentals Prices All
• Wallet Balance

SDK Infrastructure

Configuration

• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime