neucore-api

Client library of Neucore API

The version numbers correspond to the Neucore version numbers.

When updating, check the generator version in .openapi-generator/VERSION, a new version may break backwards compatibility.

Notes

If you use the esi_v2 or esi_post_v2 method, you may need to use ast.literal_eval(api_response) instead of json.loads() to parse the result.

Breaking changes

• 3.0.0
  See Neucore changelog version 3.0.0
• 1.43.0
  Player.character_id is now an integer instead of string.
• 1.21.0
  Requires Python >= 3.6
• 1.14.0
  The API is now split into several tags. This means that there are now several api Python classes instead of just one, the methods remain the same, but they have moved to other classes.
• 1.4.0
  Generated from OpenAPI v3 definition file.
  The authorization configuration changed, use access_token instead of api_key, see below.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 3.0.0
• Package version: 1.0.0
• Generator version: 7.25.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/bravecollective/neucore-api-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/bravecollective/neucore-api-python.git)

Then import the package:

import neucore_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import neucore_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import neucore_api
from neucore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://localhost/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neucore_api.Configuration(
    host = "https://localhost/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = neucore_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with neucore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neucore_api.ApplicationApi(api_client)

    try:
        # Show app information.
        api_response = api_instance.show_v1()
        print("The response of ApplicationApi->show_v1:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApplicationApi->show_v1: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost/api

Class	Method	HTTP request	Description
ApplicationApi	show_v1	GET /app/v1/show	Show app information.
ApplicationCharactersApi	character_list_v1	POST /app/v1/character-list	Returns all known characters from the parameter list.
ApplicationCharactersApi	characters_bulk_v1	POST /app/v1/characters	Returns all characters from multiple player accounts identified by character IDs.
ApplicationCharactersApi	characters_v1	GET /app/v1/characters/{characterId}	Returns all characters of the player account to which the character ID belongs.
ApplicationCharactersApi	corporation_characters_v1	GET /app/v1/corp-characters/{corporationId}	Returns a list of all known characters from the corporation.
ApplicationCharactersApi	corporation_players_v1	GET /app/v1/corp-players/{corporationId}	Returns a list of all players that have a character in the corporation.
ApplicationCharactersApi	incoming_characters_v1	GET /app/v1/incoming-characters/{characterId}	Returns all characters that were moved from another account to the player account to which the ID belongs.
ApplicationCharactersApi	main_v1	GET /app/v1/main/{cid}	Returns the main character of the player account to which the character ID belongs.
ApplicationCharactersApi	main_v2	GET /app/v2/main/{cid}	Returns the main character of the player account to which the character ID belongs.
ApplicationCharactersApi	player_characters_v1	GET /app/v1/player-chars/{playerId}	Returns all characters from the player account.
ApplicationCharactersApi	player_v1	GET /app/v1/player/{characterId}	Returns the player account to which the character ID belongs.
ApplicationCharactersApi	player_with_characters_v1	GET /app/v1/player-with-characters/{characterId}	Returns the player account to which the character ID belongs with all characters.
ApplicationCharactersApi	players_v1	POST /app/v1/players	Returns player accounts identified by character IDs. Can contain the same player several times.
ApplicationCharactersApi	removed_characters_v1	GET /app/v1/removed-characters/{characterId}	Returns all characters that were removed from the player account to which the character ID belongs.
ApplicationESIApi	esi_access_token_v1	GET /app/v1/esi/access-token/{characterId}	Returns an access token for a character and EVE login that is valid for at least 60 seconds.
ApplicationESIApi	esi_eve_login_characters_v1	GET /app/v1/esi/eve-login/{name}/characters	Returns character IDs of characters that have an ESI token (including invalid) of an EVE login.
ApplicationESIApi	esi_eve_login_token_data_v1	GET /app/v1/esi/eve-login/{name}/token-data	Returns data for all valid tokens (roles are also checked if applicable) for an EVE login. This returns cached data, it does not check if the token is still valid.
ApplicationESIApi	esi_post_v1	POST /app/v1/esi	See POST /app/v2/esi. The only difference are the return values in case of errors.
ApplicationESIApi	esi_post_v2	POST /app/v2/esi	Same as GET /app/v2/esi, but for POST requests.
ApplicationESIApi	esi_v1	GET /app/v1/esi	See GET /app/v2/esi. The only difference are the return values in case of errors.
ApplicationESIApi	esi_v2	GET /app/v2/esi	Makes an ESI GET request on behalf on an EVE character and returns the result.
ApplicationGroupsApi	alliance_groups_bulk_v1	POST /app/v1/alliance-groups	Return groups of multiple alliances.
ApplicationGroupsApi	alliance_groups_v1	GET /app/v1/alliance-groups/{aid}	Return groups of the alliance.
ApplicationGroupsApi	alliance_groups_v2	GET /app/v2/alliance-groups/{aid}	Return groups of the alliance.
ApplicationGroupsApi	corp_groups_bulk_v1	POST /app/v1/corp-groups	Return groups of multiple corporations.
ApplicationGroupsApi	corp_groups_v1	GET /app/v1/corp-groups/{cid}	Return groups of the corporation.
ApplicationGroupsApi	corp_groups_v2	GET /app/v2/corp-groups/{cid}	Return groups of the corporation.
ApplicationGroupsApi	group_members_v1	GET /app/v1/group-members/{groupId}	Returns the main character IDs from all group members.
ApplicationGroupsApi	groups_bulk_v1	POST /app/v1/groups	Return groups of multiple players, identified by one of their character IDs.
ApplicationGroupsApi	groups_v1	GET /app/v1/groups/{cid}	Return groups of the character's player account.
ApplicationGroupsApi	groups_v2	GET /app/v2/groups/{cid}	Return groups of the character's player account.
ApplicationGroupsApi	groups_with_fallback_v1	GET /app/v1/groups-with-fallback	Returns groups from the character's account, if available, or the corporation and alliance.
ApplicationMCPApi	mcp_v1	POST /app/v1/mcp	The Neucore MCP server.
ApplicationTrackingApi	member_tracking_v1	GET /app/v1/corporation/{id}/member-tracking	Return corporation member tracking data.

Documentation For Models

• Alliance
• App
• Character
• CharacterGroups
• CharacterNameChange
• Corporation
• CorporationMember
• EsiAccessToken
• EsiLocation
• EsiToken
• EsiTokenData
• EsiType
• EveLogin
• Group
• GroupApplication
• HourlyAppRequests
• MonthlyAppRequests
• Player
• PlayerLoginStatistics
• PlayerWithCharacterId
• Plugin
• PluginConfigurationDatabase
• PluginConfigurationFile
• PluginConfigurationURL
• RemovedCharacter
• Role
• SearchResult
• ServiceAccount
• SystemVariable
• TotalDailyAppRequests
• TotalMonthlyAppRequests
• Watchlist

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author